sinatra-rocketio 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 574c09d0944df2356c86d057c1e80eb81496845b
-  data.tar.gz: 237b7b7762880c7e1d875dbea7e1443731ae36ec
+  metadata.gz: f749b52c9e6cdf5d94b913387b7ed435df575a21
+  data.tar.gz: 26bb924f8435df3c0be29d0cd9cbfe0fe5551f3d
 SHA512:
-  metadata.gz: 5b05e9851fc7213cd9a486aecd761830fc1449a264d0f9a68869e4a474673e15a0d22708b054b6665515be74c2831ebd9b868e1c236a620eba8da8619cfc1c4d
-  data.tar.gz: 1d4f6b5018b2921baf2176b9a528fd5fd7f09255f2afcde4b844c652e8dbfa12455b2d70c455bd06f49fb4ea07b913b58a65ee25970b6693b164e49119d438a1
+  metadata.gz: 32782a0c0c99665694a5f8ff36af55584b610db812ea7a365e2ff218ea27ae6d6423153e31e8f03254b25ed6f6db7501801800d54038d2eb4158497d1d073282
+  data.tar.gz: c3f910f932c95ebc2806300cfd9f846ad79ad562809a3ae4001efd4961e5cbb29acfaacb8de457f156e6afd49485ee3bce9fd536b23c30f8b571f39c7cdded9c

data/HEADER.erb

@@ -0,0 +1,4 @@
+// RocketIO.js v<%= Sinatra::RocketIO::VERSION %> (websocketio:v<%= Sinatra::WebSocketIO::VERSION %>, cometio:v<%= Sinatra::CometIO::VERSION %>)
+// https://github.com/shokai/sinatra-rocketio
+// (c) 2013 Sho Hashimoto <hashimoto@shokai.org>
+// The MIT License

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.2.6 2013-05-27
+
+* JS Lib for browser
+* allow cross-domain access to /rocketio/settings
+
 === 0.2.5 2013-05-26
 
 * add function RocketIO::Client#wait

data/README.md

@@ -31,7 +31,7 @@ Server Side
 ```ruby
 require 'sinatra'
 require 'sinatra/rocketio'
-set :cometio, :timeout => 120, :post_interval => 2
+set :cometio, :timeout => 120, :post_interval => 2, :allow_crossdomain => false
 set :websocketio, :port => 5001
 set :rocketio, :websocket => true, :comet => true # enable WebSocket and Comet
 
@@ -47,7 +47,7 @@ io.push :light, {:value => 150}, {:to => session_id} # to specific client
 Client Side
 
 ```html
-<script src="//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
+<script src="//ajax.googleapis.com/ajax/libs/jquery/2.0.0/jquery.min.js"></script>
 <script src="<%= rocketio_js %>"></script>
 ```
 ```javascript
@@ -210,6 +210,40 @@ Sample App
 - https://github.com/shokai/rocketio-arduino-sample
 
 
+JavaScript Lib for browser
+--------------------------
+
+### Download
+
+- [rocketio.js](https://raw.github.com/shokai/sinatra-rocketio/master/rocketio.js)
+- [rocketio.min.js](https://raw.github.com/shokai/sinatra-rocketio/master/rocketio.min.js)
+
+
+### Usage
+
+```html
+<script src="//ajax.googleapis.com/ajax/libs/jquery/2.0.0/jquery.min.js"></script>
+<script src="/rocketio.min.js"></script>
+```
+```javascript
+var io = new RocketIO().connect("http://example.com");
+
+io.on("connect", function(){
+  alert(io.type + " connect!! " + io.session);
+});
+```
+
+### Generate JS Lib
+
+    % npm install -g uglify-js
+    % gem install bundler
+    % bundle install
+    % rake jslib
+
+=> rocketio.js and rocketio.min.js
+
+
+
 Test
 ----
 

data/Rakefile

@@ -5,6 +5,34 @@ Rake::TestTask.new do |t|
   t.pattern = "test/test_*.rb"
 end
 
+desc "generate JavaScript lib for browser"
+task :jslib do
+  dest = "rocketio.js"
+  dest_min = "rocketio.min.js"
+
+  require "rubygems"
+  require "sinatra/websocketio"
+  require "sinatra/cometio"
+  require "sinatra/rocketio"
+  require "erb"
+
+  websocketio_url = nil
+  cometio_url = nil
+  header = ERB.new(File.open(File.expand_path "HEADER.erb", File.dirname(__FILE__)).read).result(binding)
+  js = ERB.new(Sinatra::RocketIO.javascript).result(binding)
+
+  File.open(dest, "w+") do |f|
+    f.puts header
+    f.write js
+  end
+  puts " => #{dest}"
+  File.open(dest_min, "w+") do |f|
+    f.puts header
+  end
+  system "uglifyjs #{dest} >> #{dest_min}"
+  puts " => #{dest_min}"
+end
+
 desc "Start test server"
 task :test_server do
   require File.expand_path 'test/app', File.dirname(__FILE__)

data/lib/js/rocketio.js

@@ -1,30 +1,47 @@
 var RocketIO = function(opts){
   new EventEmitter().apply(this);
-  this.type = null; // "comet", "websocket"
-  this.session = null;
+  if(typeof opts === "undefined" || opts === null) opts = {};
+  this.type = opts.type || null; // "comet" or "websocket"
+  this.session = opts.session || null;
   this.channel = null;
+  if(typeof opts.channel !== "undefined" && opts.channel !== null){
+    this.channel = ""+opts.channel;
+  }
+  var setting = {};
   this.io = null;
   var self = this;
   var ws_close_timer = null;
-  if(typeof opts === "object"){
-    this.channel = ""+opts.channel;
-  }
   self.on("__connect", function(session_id){
     self.session = session_id;
     self.io.push("__channel_id", self.channel);
     self.emit("connect");
   });
 
-  this.connect = function(){
+  this.connect = function(url){
+    if(typeof url === "string"){
+      $.getJSON(url+"/rocketio/settings", function(res){
+        setting = res;
+        connect_io();
+      });
+      return self;
+    }
+    else{
+      return connect_io();
+    }
+  };
+
+  var connect_io = function(){
     self.io = function(){
       if(self.type === "comet") return;
       if(typeof WebSocketIO !== "function") return;
       var io = new WebSocketIO();
+      if(typeof setting.websocket === "string") io.url = setting.websocket;
       io.session = self.session;
       return io.connect();
     }() || function(){
       if(typeof CometIO !== "function") return;
       var io = new CometIO();
+      if(typeof setting.comet === "string") io.url = setting.comet;
       io.session = self.session;
       return io.connect();
     }();
@@ -44,7 +61,7 @@ var RocketIO = function(opts){
     ws_close_timer = setTimeout(function(){
       self.close();
       self.type = "comet";
-      self.connect();
+      connect_io();
     }, 3000);
     self.once("connect", function(){
       if(ws_close_timer) clearTimeout(ws_close_timer);

data/lib/sinatra-rocketio/application.rb

@@ -7,6 +7,7 @@ module Sinatra
       app.helpers  Sinatra::RocketIO::Helpers
       app.get '/rocketio/settings' do
         content_type 'application/json'
+        response["Access-Control-Allow-Origin"] = "*"
         @setting_json ||= (
                            setting = {}
                            setting[:websocket] = websocketio_url if Sinatra::RocketIO.options[:websocket]

data/lib/sinatra-rocketio/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module RocketIO
-    VERSION = "0.2.5"
+    VERSION = "0.2.6"
   end
 end

data/rocketio.js

@@ -0,0 +1,310 @@
+// RocketIO.js v0.2.5 (websocketio:v0.3.1, cometio:v0.5.7)
+// https://github.com/shokai/sinatra-rocketio
+// (c) 2012-2013 Sho Hashimoto <hashimoto@shokai.org>
+// The MIT License
+var RocketIO = function(opts){
+  new EventEmitter().apply(this);
+  if(typeof opts === "undefined" || opts === null) opts = {};
+  this.type = opts.type || null; // "comet" or "websocket"
+  this.session = opts.session || null;
+  this.channel = null;
+  if(typeof opts.channel !== "undefined" && opts.channel !== null){
+    this.channel = ""+opts.channel;
+  }
+  var setting = {};
+  this.io = null;
+  var self = this;
+  var ws_close_timer = null;
+  self.on("__connect", function(session_id){
+    self.session = session_id;
+    self.io.push("__channel_id", self.channel);
+    self.emit("connect");
+  });
+
+  this.connect = function(url){
+    if(typeof url === "string"){
+      $.getJSON(url+"/rocketio/settings", function(res){
+        setting = res;
+        connect_io();
+      });
+      return self;
+    }
+    else{
+      return connect_io();
+    }
+  };
+
+  var connect_io = function(){
+    self.io = function(){
+      if(self.type === "comet") return;
+      if(typeof WebSocketIO !== "function") return;
+      var io = new WebSocketIO();
+      if(typeof setting.websocket === "string") io.url = setting.websocket;
+      io.session = self.session;
+      return io.connect();
+    }() || function(){
+      if(typeof CometIO !== "function") return;
+      var io = new CometIO();
+      if(typeof setting.comet === "string") io.url = setting.comet;
+      io.session = self.session;
+      return io.connect();
+    }();
+    if(typeof self.io === "undefined"){
+      setTimeout(function(){
+        self.emit("error", "WebSocketIO and CometIO are not available");
+      }, 100);
+      return self;
+    };
+    if(self.io.url.match(/^ws:\/\/.+/)) self.type = "websocket";
+    else if(self.io.url.match(/cometio/)) self.type = "comet";
+    else self.type = "unknown";
+    self.io.on("*", function(event_name, args){
+      if(event_name === "connect") event_name = "__connect";
+      self.emit(event_name, args);
+    });
+    ws_close_timer = setTimeout(function(){
+      self.close();
+      self.type = "comet";
+      connect_io();
+    }, 3000);
+    self.once("connect", function(){
+      if(ws_close_timer) clearTimeout(ws_close_timer);
+      ws_close_timer = null;
+    });
+    return self;
+  };
+
+  this.close = function(){
+    self.io.close();
+  };
+
+  this.push = function(type, data){
+    self.io.push(type, data);
+  };
+};
+
+var CometIO = function(url, opts){
+  new EventEmitter().apply(this);
+  if(typeof opts === "undefined" || opts === null) opts = {};
+  this.url = url || "";
+  this.session = opts.session || null;
+  var running = false;
+  var self = this;
+  var post_queue = [];
+
+  var flush = function(){
+    if(!running || post_queue.length < 1) return;
+    var post_data = {
+      json: JSON.stringify({
+        session: self.session,
+        events: post_queue
+      })
+    };
+    $.ajax(
+      {
+        url : self.url,
+        data : post_data,
+        success : function(data){
+        },
+        error : function(req, stat, e){
+          self.emit("error", "CometIO push error");
+        },
+        complete : function(e){
+        },
+        type : "POST",
+        dataType : "json",
+        timeout : 10000
+      }
+    );
+    post_queue = [];
+  };
+  setInterval(flush, 1000);
+
+  this.push = function(type, data){
+    if(!running || !self.session){
+      self.emit("error", "CometIO not connected");
+      return;
+    }
+    post_queue.push({type: type, data: data})
+  };
+
+  this.connect = function(){
+    if(running) return self;
+    self.on("__session_id", function(session){
+      self.session = session;
+      self.emit("connect", self.session);
+    });
+    running = true;
+    get();
+    return self;
+  };
+
+  this.close = function(){
+    running = false;
+    self.removeListener("__session_id");
+  };
+
+  var get = function(){
+    if(!running) return;
+    $.ajax(
+      {
+        url : self.url,
+        data : {session : self.session},
+        success : function(data_arr){
+          if(data_arr !== null && typeof data_arr == "object" && !!data_arr.length){
+            for(var i = 0; i < data_arr.length; i++){
+              var data = data_arr[i];
+              if(data) self.emit(data.type, data.data);
+            }
+          }
+          get();
+        },
+        error : function(req, stat, e){
+          self.emit("error", "CometIO get error");
+          setTimeout(get, 10000);
+        },
+        complete : function(e){
+        },
+        type : "GET",
+        dataType : "json",
+        timeout : 130000
+      }
+    );
+  };
+};
+
+var WebSocketIO = function(url, opts){
+  new EventEmitter().apply(this);
+  if(typeof opts === "undefined" || opts === null) opts = {};
+  this.url = url || "";
+  this.session = opts.session || null;
+  this.websocket = null;
+  this.connecting = false;
+  var reconnect_timer_id = null;
+  var running = false;
+  var self = this;
+
+  self.on("__session_id", function(session_id){
+    self.session = session_id;
+    self.emit("connect", self.session);
+  });
+
+  this.connect = function(){
+    if(typeof WebSocket === "undefined"){
+      self.emit("error", "websocket not exists in this browser");
+      return null;
+    }
+    self.running = true;
+    var url = self.session ? self.url+"/session="+self.session : self.url;
+    self.websocket = new WebSocket(url);
+    self.websocket.onmessage = function(e){
+      try{
+        var data_ = JSON.parse(e.data);
+        self.emit(data_.type, data_.data);
+      }
+      catch(e){
+        self.emit("error", "WebSocketIO data parse error");
+      }
+    };
+    self.websocket.onclose = function(){
+      if(self.connecting){
+        self.connecting = false;
+        self.emit("disconnect");
+      }
+      if(self.running){
+        reconnect_timer_id = setTimeout(self.connect, 10000);
+      }
+    };
+    self.websocket.onopen = function(){
+      self.connecting = true;
+    };
+    return self;
+  };
+
+  this.close = function(){
+    clearTimeout(reconnect_timer_id);
+    self.running = false;
+    self.websocket.close();
+  };
+
+  this.push = function(type, data){
+    if(!self.connecting){
+      self.emit("error", "websocket not connected");
+      return;
+    }
+    self.websocket.send(JSON.stringify({type: type, data: data, session: self.session}));
+  };
+};
+
+// event_emitter.js v0.0.8
+// https://github.com/shokai/event_emitter.js
+// (c) 2013 Sho Hashimoto <hashimoto@shokai.org>
+// The MIT License
+var EventEmitter = function(){
+  var self = this;
+  this.apply = function(target, prefix){
+    if(!prefix) prefix = "";
+    for(var func in self){
+      if(self.hasOwnProperty(func) && func !== "apply"){
+        target[prefix+func] = this[func];
+      }
+    }
+  };
+  this.__events = new Array();
+  this.on = function(type, listener, opts){
+    if(typeof listener !== "function") return;
+    var event_id = self.__events.length > 0 ? 1 + self.__events[self.__events.length-1].id : 0
+    var params = {
+      id: event_id,
+      type: type,
+      listener: listener
+    };
+    for(i in opts){
+      if(!params[i]) params[i] = opts[i];
+    };
+    self.__events.push(params);
+    return event_id;
+  };
+
+  this.once = function(type, listener){
+    self.on(type, listener, {once: true});
+  };
+
+  this.emit = function(type, data){
+    for(var i = 0; i < self.__events.length; i++){
+      var e = self.__events[i];
+      switch(e.type){
+      case type:
+        e.listener(data);
+        if(e.once) e.type = null;
+        break
+      case "*":
+        e.listener(type, data);
+        if(e.once) e.type = null;
+        break
+      }
+    }
+    self.removeListener();
+  };
+
+  this.removeListener = function(id_or_type){
+    for(var i = self.__events.length-1; i >= 0; i--){
+      var e = self.__events[i];
+      switch(typeof id_or_type){
+      case "number":
+        if(e.id === id_or_type) self.__events.splice(i,1);
+        break
+      case "string":
+      case "object":
+        if(e.type === id_or_type) self.__events.splice(i,1);
+        break
+      }
+    }
+  };
+
+};
+
+if(typeof module !== "undefined" && typeof module.exports !== "undefined"){
+  module.exports = EventEmitter;
+}
+

data/rocketio.min.js

@@ -0,0 +1,5 @@
+// RocketIO.js v0.2.5 (websocketio:v0.3.1, cometio:v0.5.7)
+// https://github.com/shokai/sinatra-rocketio
+// (c) 2012-2013 Sho Hashimoto <hashimoto@shokai.org>
+// The MIT License
+var RocketIO=function(opts){(new EventEmitter).apply(this);if(typeof opts==="undefined"||opts===null)opts={};this.type=opts.type||null;this.session=opts.session||null;this.channel=null;if(typeof opts.channel!=="undefined"&&opts.channel!==null){this.channel=""+opts.channel}var setting={};this.io=null;var self=this;var ws_close_timer=null;self.on("__connect",function(session_id){self.session=session_id;self.io.push("__channel_id",self.channel);self.emit("connect")});this.connect=function(url){if(typeof url==="string"){$.getJSON(url+"/rocketio/settings",function(res){setting=res;connect_io()});return self}else{return connect_io()}};var connect_io=function(){self.io=function(){if(self.type==="comet")return;if(typeof WebSocketIO!=="function")return;var io=new WebSocketIO;if(typeof setting.websocket==="string")io.url=setting.websocket;io.session=self.session;return io.connect()}()||function(){if(typeof CometIO!=="function")return;var io=new CometIO;if(typeof setting.comet==="string")io.url=setting.comet;io.session=self.session;return io.connect()}();if(typeof self.io==="undefined"){setTimeout(function(){self.emit("error","WebSocketIO and CometIO are not available")},100);return self}if(self.io.url.match(/^ws:\/\/.+/))self.type="websocket";else if(self.io.url.match(/cometio/))self.type="comet";else self.type="unknown";self.io.on("*",function(event_name,args){if(event_name==="connect")event_name="__connect";self.emit(event_name,args)});ws_close_timer=setTimeout(function(){self.close();self.type="comet";connect_io()},3e3);self.once("connect",function(){if(ws_close_timer)clearTimeout(ws_close_timer);ws_close_timer=null});return self};this.close=function(){self.io.close()};this.push=function(type,data){self.io.push(type,data)}};var CometIO=function(url,opts){(new EventEmitter).apply(this);if(typeof opts==="undefined"||opts===null)opts={};this.url=url||"";this.session=opts.session||null;var running=false;var self=this;var post_queue=[];var flush=function(){if(!running||post_queue.length<1)return;var post_data={json:JSON.stringify({session:self.session,events:post_queue})};$.ajax({url:self.url,data:post_data,success:function(data){},error:function(req,stat,e){self.emit("error","CometIO push error")},complete:function(e){},type:"POST",dataType:"json",timeout:1e4});post_queue=[]};setInterval(flush,1e3);this.push=function(type,data){if(!running||!self.session){self.emit("error","CometIO not connected");return}post_queue.push({type:type,data:data})};this.connect=function(){if(running)return self;self.on("__session_id",function(session){self.session=session;self.emit("connect",self.session)});running=true;get();return self};this.close=function(){running=false;self.removeListener("__session_id")};var get=function(){if(!running)return;$.ajax({url:self.url,data:{session:self.session},success:function(data_arr){if(data_arr!==null&&typeof data_arr=="object"&&!!data_arr.length){for(var i=0;i<data_arr.length;i++){var data=data_arr[i];if(data)self.emit(data.type,data.data)}}get()},error:function(req,stat,e){self.emit("error","CometIO get error");setTimeout(get,1e4)},complete:function(e){},type:"GET",dataType:"json",timeout:13e4})}};var WebSocketIO=function(url,opts){(new EventEmitter).apply(this);if(typeof opts==="undefined"||opts===null)opts={};this.url=url||"";this.session=opts.session||null;this.websocket=null;this.connecting=false;var reconnect_timer_id=null;var running=false;var self=this;self.on("__session_id",function(session_id){self.session=session_id;self.emit("connect",self.session)});this.connect=function(){if(typeof WebSocket==="undefined"){self.emit("error","websocket not exists in this browser");return null}self.running=true;var url=self.session?self.url+"/session="+self.session:self.url;self.websocket=new WebSocket(url);self.websocket.onmessage=function(e){try{var data_=JSON.parse(e.data);self.emit(data_.type,data_.data)}catch(e){self.emit("error","WebSocketIO data parse error")}};self.websocket.onclose=function(){if(self.connecting){self.connecting=false;self.emit("disconnect")}if(self.running){reconnect_timer_id=setTimeout(self.connect,1e4)}};self.websocket.onopen=function(){self.connecting=true};return self};this.close=function(){clearTimeout(reconnect_timer_id);self.running=false;self.websocket.close()};this.push=function(type,data){if(!self.connecting){self.emit("error","websocket not connected");return}self.websocket.send(JSON.stringify({type:type,data:data,session:self.session}))}};var EventEmitter=function(){var self=this;this.apply=function(target,prefix){if(!prefix)prefix="";for(var func in self){if(self.hasOwnProperty(func)&&func!=="apply"){target[prefix+func]=this[func]}}};this.__events=new Array;this.on=function(type,listener,opts){if(typeof listener!=="function")return;var event_id=self.__events.length>0?1+self.__events[self.__events.length-1].id:0;var params={id:event_id,type:type,listener:listener};for(i in opts){if(!params[i])params[i]=opts[i]}self.__events.push(params);return event_id};this.once=function(type,listener){self.on(type,listener,{once:true})};this.emit=function(type,data){for(var i=0;i<self.__events.length;i++){var e=self.__events[i];switch(e.type){case type:e.listener(data);if(e.once)e.type=null;break;case"*":e.listener(type,data);if(e.once)e.type=null;break}}self.removeListener()};this.removeListener=function(id_or_type){for(var i=self.__events.length-1;i>=0;i--){var e=self.__events[i];switch(typeof id_or_type){case"number":if(e.id===id_or_type)self.__events.splice(i,1);break;case"string":case"object":if(e.type===id_or_type)self.__events.splice(i,1);break}}}};if(typeof module!=="undefined"&&typeof module.exports!=="undefined"){module.exports=EventEmitter}

data/sample/classic_style/config.ru

@@ -13,7 +13,7 @@ require 'sass'
 require File.dirname(__FILE__)+'/main'
 
 set :haml, :escape_html => true
-set :cometio, :timeout => 120, :post_interval => 2
+set :cometio, :timeout => 120, :post_interval => 2, :allow_crossdomain => true
 set :websocketio, :port => (ENV['WS_PORT'] || 8080).to_i
 set :rocketio, :comet => true, :websocket => true
 

data/sample/modular_style/config.ru

@@ -14,7 +14,7 @@ require 'sass'
 require File.dirname(__FILE__)+'/main'
 
 set :haml, :escape_html => true
-set :cometio, :timeout => 120, :post_interval => 2
+set :cometio, :timeout => 120, :post_interval => 2, :allow_crossdomain => true
 set :websocketio, :port => (ENV['WS_PORT'] || 8080).to_i
 set :rocketio, :comet => true, :websocket => true
 

data/test/app.rb

@@ -9,7 +9,7 @@ class App
   end
 
   def self.ws_port
-    ENV['WS_PORT'] || 8080
+    ENV['WS_PORT'] || 9000
   end
 
   def self.url

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-rocketio
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Sho Hashimoto
@@ -215,6 +215,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- HEADER.erb
 - History.txt
 - LICENSE.txt
 - README.md
@@ -232,6 +233,8 @@ files:
 - lib/sinatra-rocketio/version.rb
 - lib/sinatra/rocketio.rb
 - lib/sinatra/rocketio/client.rb
+- rocketio.js
+- rocketio.min.js
 - sample/classic_style/README.md
 - sample/classic_style/bin/cui_chat_client.rb
 - sample/classic_style/config.ru