simple_pusher 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTZiOWQ2ZjAxYzAyMjVlMTc3NDkyNTI0YzljOTU4MmYzOWYwNTc0Ng==
+    N2MyNzZjMjk3OTYwNGFjNWMxODQ4NmIxNDk2NDhiZGQzNDViNWU5ZA==
   data.tar.gz: !binary |-
-    MDVjZWQ4OWQ4NjU0YjkzNzQ3OGJmNzc3OWJkNTI1OTZjZDU3MDA4MQ==
+    N2M1YzcyZTM0MzI5MmU1NTdmMTdhNzdmOTcyNGM0OWQyMzU2N2JhOA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    Y2IwZGUxNTI3MzY0YzgzZTNjMWZhZDk5NmUyOTlkMWQzM2RlZjdhNWY4ZWE1
-    Mzc5MDZmNTM1MzA4NzJmMDYzM2U5ZjFlNDM0MzcwY2EzYzBmYTFkMTc2YjRi
-    YmM5MWMyYzk1YWYwOWI5M2Y1MTVkNzBkN2IxYTM3MmQwMTkyNTQ=
+    MGZkM2ZjNmFkZGEyNjc3NGVkN2E5MzBhZjYxZjI0NDQ0OTY2NDk5NDgyNGM3
+    YjBjZjIwM2M2NmQwMWE2NGMwNmIwMmJlMDI3YTM4Nzk5NjZkNzA5OWI1MjJk
+    YTU4YmE4NWE5ZDgxMDFlNDFlYmJhZjZjN2NjNjZmZjllZmJjMGQ=
   data.tar.gz: !binary |-
-    NDUwOTNlNzUxNzRiNTVkZDRiNGZkYTcxNWNmNjRmNjkwNTc4NzZhZWRkZWY3
-    ZWUwYjgxMjgzMWFmYjdlNWFkNjIzZjQxMWQ1YTIwYzA5OGIyOTBkZGI2YWMy
-    MjRmNThkODVmNjJmYzFkM2JhMzdhNjU5ODVhZDMxZDg3ZmM2MWM=
+    MTY4M2UzZjUyM2I2MTVjYTU2ZWNlMTkzMWU4NmM2ZDU3ZDZmYTIxZDI5MDM2
+    OGUzMGRjODI1MDRiNzBlYmQ0YzcyYjM5NjIxZTg2MWM4NGMyMTg3ODFmZGU5
+    NzgyMWM2MjhmMjU0ZTg2MzYzM2U0Y2JkYjAxYmU0ZTIzMzg2YWU=

data/README.md

@@ -1,6 +1,6 @@
 # SimplePusher
 
-SimplePusher is a HTML5 websocket powered realtime messaging tool.
+SimplePusher is a HTML5 websocket powered realtime messaging tool used in Rails project.
 
 ## Installation
 
@@ -16,46 +16,60 @@ Or install it yourself as:
 
     $ gem install simple_pusher
 
-## Usage
+Then start simple pusher server when rails app boot:
 
-1. Start simple pusher server in rails config/initializers.
+    # config/initializers/simple_pusher.rb
+    EventMachine.next_tick do
+      SimplePusher.setup do |config|
+        config.port = 8088
+        config.debug = false
+      end
+      SimplePusher.start
+    end
 
-```
-# config/initializers/simple_pusher.rb
-EventMachine.next_tick do
-  SimplePusher.setup do |config|
-    config.port = 8088
-    config.debug = false
-  end
-  SimplePusher.start
-end
-```
+### Note
 
-2. Setup client js code.
+As initializer code `config/initializers/simple_pusher.rb` show, your rails runtime environment must be in EventMachine run loop. Otherwise you start EventMachine run loop in a new thread.
 
-```
-    var simple_pusher = new SimplePusher("ws://<%= request.host %>:8088/");
-    simple_pusher.on("message", function(message){
-        console.log("Receive:", message )
-    });
+## Usage
+
+Setup client js code.
 
-    simple_pusher.on("online_count", function(message){
+Add `//= require simple_pusher` to app/assets/javascripts/application.js
 
-    });
+Add code to app/views/layouts/application.html.erb
+```
+<script type="text/javascript">
+    var simple_pusher = new SimplePusher("ws://<%= request.host %>:8088/");
+    simple_pusher.broadcast("Hello everybody.");
+</script>
 ```
 
-3. Broadcast message via server side.
+Broadcast message via server side.
 
 ```
 SimplePusher.broadcast("Time now #{Time.now.to_s(:db}")
 ```
 
-4. Broadcast message via client side.
+Message callback at server side.
 
 ```
-simple_pusher.broadcast("Hello everybody.")
+SimplePusher.on("ping") do
+  puts "I received ping request."
+end
+
+SimplePusher.on("ping") do
+  puts "I also received ping request."
+end
 ```
 
+## Emulating WebSockets in older browsers
+It is possible to emulate WebSockets in older browsers using flash emulation. For example take a look at the [web-socket-js](https://github.com/gimite/web-socket-js) project.
+
+## TODO
+
+* Add `on` method message callback to client js.
+
 ## Contributing
 
 1. Fork it

data/lib/simple_pusher/connection.rb

@@ -7,6 +7,19 @@ module SimplePusher
       @@clients ||= {}
     end
 
+    def self.callbacks
+      @@callbacks ||= {}
+    end
+
+    def self.on(event, &callback)
+      callbacks[event] ||= []
+      callbacks[event] << callback
+    end
+
+    def self.trigger(event)
+      callbacks[event].each {|callback| callback.call }
+    end
+
     def self.add_client(socket)
       client = self.new(socket)
       clients[socket] = client

data/lib/simple_pusher/server.rb

@@ -34,6 +34,9 @@ module SimplePusher
            when 'broadcast'
              message = message.join(":")
              Connection.broadcast(message)
+           when 'emit'
+             event = message[0]
+             Connection.trigger(event)
            else
              #TODO
           end

data/lib/simple_pusher/version.rb

@@ -1,3 +1,3 @@
 module SimplePusher
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/simple_pusher.rb

@@ -25,8 +25,13 @@ module SimplePusher
     Connection.broadcast(message)
   end
 
+  def on(event, &callback)
+    Connection.on(event, &callback)
+  end
+
   module_function :start
   module_function :broadcast
+  module_function :on
 
 end
 

data/test/configuration_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path("../test_helper", __FILE__)
+
+describe SimplePusher::Configuration do
+  it "must respond to debug method" do
+    configuration = SimplePusher::Configuration.new
+    configuration.debug.must_equal false #default to false
+  end
+
+  it "must respond to port method" do
+    configuration = SimplePusher::Configuration.new
+    configuration.port.must_equal 8088 #default to 8088
+  end
+
+end

data/test/simple_pusher_test.rb

@@ -6,8 +6,14 @@ describe SimplePusher do
     SimplePusher::VERSION.wont_be_nil
   end
 
-  it "must respond listen method" do
-    #SimplePusher.repond_with
+  it "setup method work" do
+    # EventMachine.run do
+    #
+    # end
+    SimplePusher.setup do |c|
+      c.port = 8888
+    end
+    SimplePusher.configuration.port.must_equal 8888
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_pusher
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - qichunren
@@ -71,6 +71,7 @@ files:
 - lib/simple_pusher/server.rb
 - lib/simple_pusher/version.rb
 - simple_pusher.gemspec
+- test/configuration_test.rb
 - test/simple_pusher_test.rb
 - test/test_helper.rb
 - vendor/assets/javascripts/simple_pusher.coffee
@@ -99,5 +100,6 @@ signing_key:
 specification_version: 4
 summary: Simple pusher based on websocket, build with Eventmachine
 test_files:
+- test/configuration_test.rb
 - test/simple_pusher_test.rb
 - test/test_helper.rb