padrino-websockets 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29fa2c66e13018259a69e4c31ae06bd65c6e636b
-  data.tar.gz: 65df06207d203791552bf15743e380a7236dd110
+  metadata.gz: 48a6c2dbc40407de9d89363244273ea101a333b9
+  data.tar.gz: f55b458cb97d4931a9bb9178827961e5a3a24819
 SHA512:
-  metadata.gz: ad15ee0928289ec7ddb10c7d2f079ef42de8d43ac2935d8855d9e52c0e539d5ce31b4538037892020d1861a4c9c625e6778249211ba7199017c208fdcb5a978c
-  data.tar.gz: 7846d58a63850da913458687f0d2535d529d83b57ca39a986df9a5ed4325c4cd2549fcdf9d1cdef9080c4d878bd3c3c1ef6d5460741671dabae3ad663e032fa4
+  metadata.gz: de5f1cc610fb4b047ca7beea1b5d735fab5eb5fb298085efb96578c45eed5fa7b4673ebf1b8fbb36be3b57b0b310a677960042e32c696d3877cd267c213d1def
+  data.tar.gz: b1f972357d3054ebe90b4fa5c727acc90a16d8b59e40ed0500e83591a81e391e6a0f2def90f02279a8ecb15fe3d2ff43c43d77e3c1df35045f62ec7441af6e1e

data/README.md

@@ -5,20 +5,25 @@ A WebSockets abstraction for the Padrino Ruby Web Framework to manage
 
 ## Current support
 
-The current version supports [SpiderGazelle](https://github.com/cotag/spider-gazelle) as its
-backend working with LibUV.
+* [SpiderGazelle](https://github.com/cotag/spider-gazelle) a LibUV application server.
+* [Puma](http://puma.io/) >= 2.0. (*)
+* [Thin](http://code.macournoyer.com/thin/) (*)
+* [Rainbows](http://rainbows.rubyforge.org/) (*) (**)
+* [Goliath](http://postrank-labs.github.com/goliath/) (*) (**)
+* [Phusion Passenger](https://www.phusionpassenger.com/) >= 4.0 with nginx >= 1.4 (*) (**)
+
+(*) Supported through [faye-websocket-ruby](https://github.com/faye/faye-websocket-ruby).
+(**) Untested.
+
+
+UPDATE: See the [faye-support](https://github.com/dariocravero/padrino-websockets/tree/faye-support) branch for Thin support (more updats coming on this).
 
-Feel free to implement your own backend using, say, EventMachine and submit it! :)
 
 ## Installation
 
 Add this line to your application's `Gemfile`:
 
 ```
-# It only works with SpiderGazelle for now, so this dependency is a must at the moment.
-gem 'spider-gazelle', github: 'cotag/spider-gazelle'
-gem 'uv-rays', github: 'cotag/uv-rays'
-
 gem 'padrino-websockets'
 ```
 
@@ -46,7 +51,7 @@ Then in any controller or in the app itself, define a WebSocket channel:
 
 ```
 websocket :channel do
-  event :ping do |context, message|
+  on :ping do |message|
     send_message({pong: true, data: message})
   end
 end

data/lib/padrino-websockets/base-event-manager.rb

@@ -46,6 +46,7 @@ module Padrino
       def event(name, &block)
         @events[name.to_sym] = block if block_given?
       end
+      alias :on :event
 
       ##
       # Message receiver
@@ -86,13 +87,12 @@ module Padrino
           end
 
           # Call it
-          # TODO Run the event in the context of the app
-          # @events[event].bind(@event_context).call
           # TODO Make the params (message) available through the params variable as we do
           # in normal actions.
           logger.debug "Calling event: #{event} as user: #{@user} on channel #{@channel}."
           logger.debug message.inspect
-          @events[event].call(@event_context, message)
+          # Run the event in the context of the app
+          @event_context.instance_exec message, &@events[event]
         rescue Oj::ParseError => e
           logger.error ERRORS[:parse_message]
           logger.error e.message
@@ -127,20 +127,6 @@ module Padrino
         @@connections[@channel].delete(@ws)
       end
 
-      ##
-      # Broadcast a message to the whole channel
-      #
-      def broadcast(message, except=[])
-        self.class.broadcast @channel, message, except
-      end
-
-      ##
-      # Send a message to a user on the channel
-      #
-      def send_message(message, user=@user)
-        self.class.send_message @channel, user, message
-      end
-
       class << self
         ##
         # Broadcast a message to the whole channel.

data/lib/padrino-websockets/faye/event-manager.rb

@@ -0,0 +1,45 @@
+module Padrino
+  module WebSockets
+    module Faye
+      class EventManager < BaseEventManager
+        def initialize(channel, user, ws, event_context, &block)
+          ws.on :open do |event|
+            self.on_open event #&method(:on_open)
+          end
+          ws.on :message do |event|
+            self.on_message event.data, @ws
+          end
+          ws.on :close do |event|
+            self.on_shutdown event # method(:on_shutdown)
+          end
+
+          super channel, user, ws, event_context, &block
+        end
+
+        ##
+        # Manage the WebSocket's connection being closed.
+        #
+        def on_shutdown(event)
+          @pinger.cancel if @pinger
+        end
+
+        ##
+        # Write a message to the WebSocket.
+        #
+        def self.write(message, ws)
+          ws.send ::Oj.dump(message)
+        end
+
+        protected
+          ##
+          # Maintain the connection if ping frames are supported
+          #
+          def on_open(event)
+            super event
+
+            @ws.ping('pong')
+          end
+      end
+    end
+  end
+end

data/lib/padrino-websockets/faye/helpers.rb

@@ -0,0 +1,15 @@
+module Padrino
+  module WebSockets
+    module Faye
+      module Helpers
+        def send_message(channel, user, message)
+          Padrino::WebSockets::Faye::EventManager.send_message channel, user, message
+        end
+
+        def broadcast(channel, message, except=[])
+          Padrino::WebSockets::Faye::EventManager.broadcast channel, message, except
+        end
+      end
+    end
+  end
+end

data/lib/padrino-websockets/faye/puma-patch.rb

@@ -0,0 +1,24 @@
+module Faye
+  class RackStream
+    def initialize(socket_object)
+      @socket_object = socket_object
+      @connection    = socket_object.env['em.connection']
+      @stream_send   = socket_object.env['stream.send']
+
+      if socket_object.env['rack.hijack']
+        socket_object.env['rack.hijack'].call
+        #
+        # FIXME For some reason `rack.hijack_io` isn't set in `Padrino` when using it with `Puma`.
+        # In the meantime, if you're using this, you can get away with `puma.socket`
+        #
+        @rack_hijack_io = socket_object.env['rack.hijack_io'] || socket_object.env['puma.socket']
+        EventMachine.attach(@rack_hijack_io, Reader) do |reader|
+          @rack_hijack_io_reader = reader
+          reader.stream = self
+        end
+      end
+
+      @connection.socket_stream = self if @connection.respond_to?(:socket_stream)
+    end
+  end
+end

data/lib/padrino-websockets/faye/routing.rb

@@ -0,0 +1,29 @@
+module Padrino
+  module WebSockets
+    module Faye
+      module Routing
+        require 'faye/websocket'
+
+        ##
+        # Creates a WebSocket endpoint using SpiderGazelle + libuv.
+        #
+        # It handles upgrading the HTTP connection for you.
+        # You can nest this inside controllers as you would do with regular actions in Padrino.
+        #
+        def websocket(channel, *args, &block)
+          get channel, *args do
+            # Let some other action try to handle the request if it's not a WebSocket.
+            throw :pass unless ::Faye::WebSocket.websocket?(request.env)
+
+            set_websocket_user
+            ws = ::Faye::WebSocket.new(env, nil, {ping: 15})
+            Padrino::WebSockets::Faye::EventManager.new(channel, session['websocket_user'],
+                                                        ws, self, &block)
+            ws.rack_response
+          end
+        end
+        alias :ws :websocket
+      end
+    end
+  end
+end

data/lib/padrino-websockets/faye.rb

@@ -0,0 +1,9 @@
+module Padrino
+  module WebSockets
+    module Faye
+      require 'padrino-websockets/faye/helpers'
+      require 'padrino-websockets/faye/routing'
+      require 'padrino-websockets/faye/event-manager'
+    end
+  end
+end

data/lib/padrino-websockets/spider-gazelle/helpers.rb

@@ -5,8 +5,9 @@ module Padrino
         def send_message(channel, user, message)
           Padrino::WebSockets::SpiderGazelle::EventManager.send_message channel, user, message
         end
-        def broadcast(channel, message)
-          Padrino::WebSockets::SpiderGazelle::EventManager.broadcast channel, message
+
+        def broadcast(channel, message, except=[])
+          Padrino::WebSockets::SpiderGazelle::EventManager.broadcast channel, message, except
         end
       end
     end

data/lib/padrino-websockets/version.rb

@@ -1,5 +1,5 @@
 module Padrino
   module Websockets
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/padrino-websockets.rb

@@ -18,8 +18,16 @@ module Padrino
           require 'padrino-websockets/spider-gazelle'
           app.helpers Padrino::WebSockets::SpiderGazelle::Helpers
           app.extend Padrino::WebSockets::SpiderGazelle::Routing
+        elsif defined?(::Faye::WebSocket)
+          require 'padrino-websockets/faye'
+          ::Faye::WebSocket.load_adapter('thin') if defined?(::Thin)
+          require 'padrino-websockets/faye/puma-patch' if defined?(Puma)
+          app.helpers Padrino::WebSockets::Faye::Helpers
+          app.extend Padrino::WebSockets::Faye::Routing
         else
-          logger.error "Can't find a WebSockets backend. At the moment we only support SpiderGazelle."
+          logger.error %Q{Can't find a WebSockets backend. At the moment we only support
+            SpiderGazelle and Faye Websockets friendly application backends (Puma and Thin work,
+            Rainbows, Goliath and Phusion Passenger remain untested and may break).}
           raise NotImplementedError
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: padrino-websockets
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Darío Javier Cravero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-23 00:00:00.000000000 Z
+date: 2014-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,11 @@ files:
 - examples/padrino-app/public/favicon.ico
 - lib/padrino-websockets.rb
 - lib/padrino-websockets/base-event-manager.rb
+- lib/padrino-websockets/faye.rb
+- lib/padrino-websockets/faye/event-manager.rb
+- lib/padrino-websockets/faye/helpers.rb
+- lib/padrino-websockets/faye/puma-patch.rb
+- lib/padrino-websockets/faye/routing.rb
 - lib/padrino-websockets/spider-gazelle.rb
 - lib/padrino-websockets/spider-gazelle/event-manager.rb
 - lib/padrino-websockets/spider-gazelle/helpers.rb
@@ -95,3 +100,4 @@ signing_key:
 specification_version: 4
 summary: A WebSockets abstraction for Padrino
 test_files: []
+has_rdoc: