celluloid-websocket 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cedcb4a302c02dba995a888f608bd1a925267660
+  data.tar.gz: 04158005fe81ce1264066d51249ffe7bac99aaeb
+SHA512:
+  metadata.gz: 16c9a762d83d2a4d95cd2d0db1b17d897ada642879f40e27167897054dfd99c9ff6bfb3632433fd25a8010ca1c1633f832561599645b81a8d3ba6f49d8051b5b
+  data.tar.gz: ad9a96ec44fc288cfefd8d6077fca526a010dfe4b9dc8a617d88b61346b332022e25eea844566ec32f98646f64a55188808b7858f2f5cf1d803af15d3135a6e7

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.pid
+*.log
+*.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in celluloid-websocket-rack.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tinco Andringa
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Celluloid::WebSocket
+
+Lets you make a websocket rack application using Celluloid.
+
+With thanks to Tony Arcieri for his awesome Celluloid libraries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'celluloid-websocket'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install celluloid-websocket
+
+## Usage
+
+Simply inherit your Rack app from Celluloid::WebSocket::Rack, and implement the `on_open` method and using the `read` and `write` functions to implement a protocol. 
+
+```
+require 'celluloid/websocket/rack'
+
+class WebSocketEcho < Celluloid::WebSocket::Rack
+	def on_open
+		@counter = 0
+
+		while(true)
+			message = read
+			@counter += 1
+			write("#{@counter}: #{message}")			
+		end
+	end
+end
+
+run(WebSocketEcho)
+```
+
+You can try it out by cloning this repository running `bundle` and then:
+
+```
+passenger start -R examples/message_counter.ru
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/celluloid-websocket.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'celluloid/websocket/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "celluloid-websocket"
+  spec.version       = Celluloid::WebSocket::VERSION
+  spec.authors       = ["Tinco Andringa"]
+  spec.email         = ["mail@tinco.nl"]
+  spec.description   = "Lets you make a websocket rack application using Celluloid."
+  spec.summary       = "This is basically a small wrapper around Tony Arcieri's Reel::Websocket class."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "http"
+  spec.add_dependency "websocket-driver", '>= 0.5.1'
+  spec.add_dependency "rack"
+  spec.add_dependency "celluloid"
+  spec.add_dependency "celluloid-io"
+end

data/examples/message_counter.ru

@@ -0,0 +1,20 @@
+require 'celluloid/websocket/rack'
+
+class WebSocketEcho < Celluloid::WebSocket::Rack
+	def on_open
+		@counter = 0
+
+		while(true)
+			message = read
+
+			@counter += 1
+			write("#{@counter}: #{message}")
+		end
+	end
+
+	def on_error(*args)
+		puts args.inspect
+	end
+end
+
+run(WebSocketEcho)

data/lib/celluloid/io/rack_socket.rb

@@ -0,0 +1,35 @@
+require 'forwardable'
+require 'celluloid/io'
+
+module Celluloid
+	module IO
+		# Wraps a socket as gotten from the Rack hijack API
+		class RackSocket < Stream
+			extend Forwardable
+
+			def_delegators :@socket, :read_nonblock, :write_nonblock, :close, :close_read, :close_write, :closed?
+
+			def initialize(socket)
+				super()
+				@socket = socket
+			end
+
+			def to_io
+				@socket
+			end
+
+			# Receives a message
+			def recv(maxlen, flags=nil)
+				raise NotImplementedError, "flags not supported" if flags && !flags.zero?
+				readpartial(maxlen)
+			end
+
+			# Send a message
+			def send(msg, flags, dest_sockaddr = nil)
+				raise NotImplementedError, "dest_sockaddr not supported" if dest_sockaddr
+				raise NotImplementedError, "flags not supported" unless flags.zero?
+				write(msg)
+			end
+		end
+	end
+end

data/lib/celluloid/websocket.rb

@@ -0,0 +1,103 @@
+require 'forwardable'
+require 'websocket/driver'
+require 'uri'
+require 'rack/request'
+
+module Celluloid
+	class WebSocket
+		extend Forwardable
+
+		attr_accessor :socket, :env
+
+		def initialize(env, socket)
+			@env = env
+    	@socket = socket
+
+    	driver_env = DriverEnvironment.new(env, socket) 
+
+			@driver = ::WebSocket::Driver.rack(driver_env)
+
+			@driver.on(:close) do
+				@socket.close
+			end
+
+			@message_stream = MessageStream.new(socket, @driver)
+
+			@driver.start
+		rescue EOFError
+			close
+		end
+
+		def read
+			@message_stream.read
+		end
+
+		def closed?
+			@socket.closed?
+		end
+
+		def write(msg)
+			if msg.is_a? String
+				@driver.text(msg)
+			elsif msg.is_a? Array
+				@driver.binary(msg)
+			else
+				raise "Can only send byte array or string over driver."
+			end
+		rescue IOError, Errno::ECONNRESET, Errno::EPIPE
+			cancel_timer!
+			raise SocketError, "error writing to socket"
+		rescue
+			cancel_timer!
+			raise
+		end
+		alias_method :<<, :write
+
+		def close
+			@driver.close
+			@socket.close
+		end
+
+		private
+
+		class DriverEnvironment
+			extend Forwardable
+
+			attr_reader :env, :url, :socket
+
+			def_delegators :socket, :write
+
+			def initialize(env, socket)
+				@env = env
+
+				secure = ::Rack::Request.new(env).ssl?
+   			scheme = secure ? 'wss:' : 'ws:'
+        @url = scheme + '//' + env['HTTP_HOST'] + env['REQUEST_URI']
+
+				@socket = socket
+			end
+		end
+
+		class MessageStream
+			BUFFER_SIZE = 16384
+
+			def initialize(socket, driver)
+				@socket = socket
+				@driver = driver
+				@message_buffer = []
+
+				@driver.on :message do |message|
+					@message_buffer.push(message.data)
+				end
+			end
+
+			def read
+				while @message_buffer.empty?
+					buffer = @socket.readpartial(BUFFER_SIZE)
+					@driver.parse(buffer)
+				end
+				@message_buffer.shift
+			end
+		end
+	end
+end

data/lib/celluloid/websocket/rack.rb

@@ -0,0 +1,42 @@
+require 'celluloid'
+require 'celluloid/io'
+require 'celluloid/websocket'
+require 'celluloid/io/rack_socket'
+require 'rack/request'
+require 'forwardable'
+
+module Celluloid
+	class WebSocket
+		class Rack
+			extend Forwardable
+			include Celluloid::IO
+			include Celluloid::Logger
+
+			finalizer :shutdown
+
+			def_delegators :@websocket, :socket, :env, :addr, :peeraddr, :read, :read_every, :write, :<<, :closed?, :close, :cancel_timer!
+
+			def self.call(env)
+				if env['HTTP_UPGRADE'].nil? || env['HTTP_UPGRADE'].downcase != 'websocket'
+					return [400, {}, "No Upgrade header or Upgrade not for websocket."]
+				end
+
+				env['rack.hijack'].call
+				socket = Celluloid::IO::RackSocket.new(env['rack.hijack_io'].to_io)
+
+				actor = new()
+				actor.async.initialize_websocket(env, socket)
+				[200,{},""]
+			end
+
+			def initialize_websocket(req, socket)
+				@websocket = WebSocket.new(req, socket)
+				on_open if respond_to? :on_open
+			end
+
+			def shutdown
+				@websocket.close if @websocket
+			end
+		end
+	end
+end

data/lib/celluloid/websocket/version.rb

@@ -0,0 +1,5 @@
+module Celluloid
+	class WebSocket
+		VERSION = "0.0.1"
+	end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: celluloid-websocket
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tinco Andringa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: websocket-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: celluloid-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lets you make a websocket rack application using Celluloid.
+email:
+- mail@tinco.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- celluloid-websocket.gemspec
+- examples/message_counter.ru
+- lib/celluloid/io/rack_socket.rb
+- lib/celluloid/websocket.rb
+- lib/celluloid/websocket/rack.rb
+- lib/celluloid/websocket/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This is basically a small wrapper around Tony Arcieri's Reel::Websocket class.
+test_files: []