rev-websocket 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+*.gemspec

data/README.rdoc

@@ -0,0 +1,76 @@
+= Rev-WebSocket
+
+Rev-WebSocket is a WebSocket server implementation based on Rev,
+a high performance event-driven I/O library for Ruby.
+
+This library conforms to WebSocket draft-75 and draft-76.
+
+- http://github.com/frsyuki/rev-websocket
+
+
+== Simple example
+
+    gem install rev-websocket
+
+
+== Simple example
+
+    require 'rubygems'
+    require 'rev/websocket'
+    
+    class MyConnection < Rev::WebSocket
+      def on_open
+        puts "WebSocket opened"
+        send_message("Hello, world!")
+      end
+    
+      def on_message(data)
+        puts "WebSocket data received: '#{data}'"
+        send_message("echo: #{data}")
+      end
+    
+      def on_close
+        puts "WebSocket closed"
+      end
+    end
+    
+    host = '0.0.0.0'
+    port = '8081'
+    
+    server = Rev::WebSocketServer.new(host, port, MyConnection)
+    server.attach(Rev::Loop.default)
+    
+    Rev::Loop.run
+
+
+== Learn more
+
+- [Rev API reference] http://rev.rubyforge.org/rdoc/
+- [JSON for object serialization] http://github.com/brianmario/yajl-ruby
+- [MessagePack for object serialization] http://msgpack.org/
+- [The WebSocket protocol draft-76] http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76
+
+
+== License
+
+Copyright (c) 2010 FURUHASHI Sadayuki
+
+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/Rakefile

@@ -0,0 +1,21 @@
+require 'rake'
+
+begin
+	require 'jeweler'
+	Jeweler::Tasks.new do |gemspec|
+		gemspec.name = "rev-websocket"
+		gemspec.summary = "WebSocket server based on Rev"
+		gemspec.description = "Rev-WebSocket is a WebSocket server implementation based on Rev, a high performance event-driven I/O library for Ruby. This library conforms to WebSocket draft-75 and draft-76."
+		gemspec.email = "frsyuki@users.sourceforge.jp"
+		gemspec.homepage = "http://github.com/frsyuki/rev-websocket"
+		gemspec.authors = ["FURUHASHI Sadayuki"]
+		gemspec.add_dependency("rev", ">= 0.3.2")
+		gemspec.add_dependency("thin", '>= 1.2.7')
+	end
+	Jeweler::GemcutterTasks.new
+rescue LoadError
+	puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+task :default => :build
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rev-websocket.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__)+'/rev/websocket'

data/lib/rev/websocket.rb

@@ -0,0 +1,223 @@
+require 'rev'
+require File.dirname(__FILE__)+'/websocket/spec'
+require 'thin_parser'
+
+module Rev
+	class WebSocketServer < TCPServer
+		def initialize(host, port = nil, klass = WebSocket, *args, &block)
+			super
+		end
+	end
+
+	# WebSocket spec:
+	# http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76
+
+	class WebSocket < TCPSocket
+		def on_open
+		end
+
+		def on_message(data)
+		end
+
+		def on_error(reason)
+		end
+
+		attr_reader :request
+
+		def send_message(data)
+			if HAVE_ENCODING
+				frame = FRAME_START + data.force_encoding('UTF-8') + FRAME_END
+			else
+				frame = FRAME_START + data + FRAME_END
+			end
+			write frame
+		end
+
+		if "".respond_to?(:force_encoding)
+			HAVE_ENCODING = true
+			FRAME_START = "\x00".force_encoding('UTF-8')
+			FRAME_END   = "\xFF".force_encoding('UTF-8')
+		else
+			HAVE_ENCODING = false
+			FRAME_START = "\x00"
+			FRAME_END   = "\xFF"
+		end
+
+		#HTTP11_PRASER = Mongrel::HttpParser
+		HTTP11_PRASER = Thin::HttpParser
+
+		# Thin::HttpParser tries to call request['rack.input'].write(body)
+		class DummyIO
+			KEY = 'rack.input'
+			def write(data) end
+		end
+
+		def initialize(socket)
+			super
+			@state = :process_handshake
+			@data = ::IO::Buffer.new
+			@http11 = HTTP11_PRASER.new
+			@http11_nbytes = 0
+			@request = {DummyIO::KEY => DummyIO.new}
+		end
+
+		def on_read(data)
+			@data << data
+			dispatch
+		end
+
+		protected
+
+		def dispatch
+			while __send__(@state)
+			end
+		end
+
+		def process_handshake
+			return false if @data.empty?
+
+			data = @data.to_str
+			begin
+				@http11_nbytes = @http11.execute(@request, data, @http11_nbytes)
+			rescue
+				on_error "invalid HTTP header, parsing fails"
+				@state = :invalid_state
+				close
+			end
+
+			return false unless @http11.finished?
+
+			@data.read(@http11_nbytes)
+			remove_instance_variable(:@http11)
+			remove_instance_variable(:@http11_nbytes)
+
+			@request.delete(DummyIO::KEY)
+
+			unless @request["REQUEST_METHOD"] == "GET"
+				raise RuntimeError, "Request method must be GET"
+			end
+
+			unless @request['HTTP_CONNECTION'] == 'Upgrade' and @request['HTTP_UPGRADE'] == 'WebSocket'
+				raise RequestError, "Connection and Upgrade headers required"
+			end
+
+			@state = :process_frame_header
+
+			version = @request['HTTP_SEC_WEBSOCKET_KEY1'] ? 76 : 75
+			begin
+				case version
+				when 75
+					extend Spec75
+				when 76
+					extend Spec76
+				end
+
+				if handshake
+					on_open
+				end
+
+			rescue
+				on_bad_request
+			end
+		end
+
+		def on_bad_request
+			write "HTTP/1.1 400 Bad request\r\n\r\n"
+			close
+		end
+
+		def process_frame_header
+			return false if @data.empty?
+
+			@frame_type = @data.read(1).to_i
+			if (@frame_type & 0x80) == 0x80
+				@binary_length = 0
+				@state = :process_binary_frame_header
+			else
+				@state = :process_text_frame
+			end
+
+			return true
+		end
+
+		def process_binary_frame_header
+			until @data.empty?
+
+				b = @data.read(1).to_i
+				b_v = b & 0x7f
+				@binary_length = (@binary_length<<7) | b_v
+
+				if (b & 0x80) == 0x80
+					if @binary_length == 0
+						# If the /frame type/ is 0xFF and the /length/ was 0
+						write "\xff\x00"
+						@state = :invalid_state
+						close
+						return false
+					end
+
+					@state = :process_binary_frame
+					return true
+				end
+
+			end
+			return false
+		end
+
+		def process_binary_frame
+			return false if @data.size < @binary_length
+
+			# Just discard the read bytes.
+			@data.read(@binary_length)
+
+			@state = :process_frame_header
+			return true
+		end
+
+		def process_text_frame
+			return false if @data.empty?
+
+			pos = @data.to_str.index("\xff")
+			if pos.nil?
+				return false
+			end
+
+			msg = @data.read(pos)
+			@data.read(1)  # read 0xff byte
+
+			@state = :process_frame_header
+
+			if @frame_type != 0x00
+				# discard the data
+				return true
+			end
+
+			msg.force_encoding('UTF-8') if HAVE_ENCODING
+			on_message(msg)
+
+			return true
+		end
+
+		def ssl?
+			false
+		end
+
+		private
+
+		def invalid_state
+			raise RuntimeError, "invalid state"
+		end
+	end
+
+	class SSLWebSocket < WebSocket
+		def on_connect
+			extend SSL
+			ssl_server_start
+		end
+
+		def ssl?
+			true
+		end
+	end
+end
+

data/lib/rev/websocket/spec.rb

@@ -0,0 +1,108 @@
+require 'digest/md5'
+
+module Rev
+	class WebSocket < TCPSocket
+
+		module Spec75
+			protected
+
+			def handshake
+				schema = (ssl? ? 'wss' : 'ws')
+				location = "#{schema}://#{@request['HTTP_HOST']}#{@request['REQUEST_URI']}"
+
+				upgrade =  "HTTP/1.1 101 Web Socket Protocol Handshake\r\n"
+				upgrade << "Upgrade: WebSocket\r\n"
+				upgrade << "Connection: Upgrade\r\n"
+				upgrade << "WebSocket-Origin: #{@request['HTTP_ORIGIN']}\r\n"
+				upgrade << "WebSocket-Location: #{location}\r\n\r\n"
+
+				write upgrade
+
+				return true  # opened
+			end
+		end
+
+		module Spec76
+			protected
+
+			def handshake
+				@state_save = @state
+				@state = :process_challenge_response
+
+				return false # not yet opened
+			end
+
+			def process_challenge_response
+				return false if @data.size < 10
+
+				crln = @data.read(2)  # read \r\n bytes
+				if crln != "\r\n"
+					raise RuntimeError, "invalid request"
+				end
+
+				key_3 = @data.read(8)
+
+				@state = remove_instance_variable(:@state_save)
+
+				challenge_response = do_challenge_response(
+					@request['HTTP_SEC_WEBSOCKET_KEY1'],
+					@request['HTTP_SEC_WEBSOCKET_KEY2'],
+					key_3)
+
+				schema = (ssl? ? 'wss' : 'ws')
+				location = "#{schema}://#{@request['HTTP_HOST']}#{@request['REQUEST_URI']}"
+
+				upgrade =  "HTTP/1.1 101 WebSocket Protocol Handshake\r\n"
+				upgrade << "Upgrade: WebSocket\r\n"
+				upgrade << "Connection: Upgrade\r\n"
+				upgrade << "Sec-WebSocket-Location: #{location}\r\n"
+				upgrade << "Sec-WebSocket-Origin: #{@request['HTTP_ORIGIN']}\r\n"
+				if proto = @request['HTTP_SEC_WEBSOCKET_PROTOCOL']
+					# FIXME server is requed to confirm the subprotocol of the connection
+					upgrade << "Sec-WebSocket-Protocol: #{proto}\r\n"
+				end
+				upgrade << "\r\n"
+				upgrade << challenge_response
+
+				write upgrade
+
+				on_open
+
+				return true
+
+			rescue
+				on_bad_request
+				return false
+			end
+
+			private
+			def do_challenge_response(key_1, key_2, key_3)
+				key_number_1 = key_1.scan(/[0-9]/).join.to_i
+				key_number_2 = key_2.scan(/[0-9]/).join.to_i
+				spaces_1 = key_1.count(' ')
+				spaces_2 = key_2.count(' ')
+
+				if spaces_1 == 0 || spaces_2 == 0
+					raise RuntimeError, "invalid challenge key"
+				end
+
+				if key_number_1 % spaces_1 != 0 || key_number_2 % spaces_2 != 0
+					raise RuntimeError, "invalid challenge key"
+				end
+
+				part_1 = key_number_1 / spaces_1
+				part_2 = key_number_2 / spaces_2
+
+				challenge = [part_1, part_2].pack('NN') + key_3[0,8]
+				response = Digest::MD5.digest(challenge)
+
+				return response
+
+			rescue
+				on_bad_request
+			end
+		end
+
+	end
+end
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: rev-websocket
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- FURUHASHI Sadayuki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-12 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rev
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thin
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.7
+    version: 
+description: Rev-WebSocket is a WebSocket server implementation based on Rev, a high performance event-driven I/O library for Ruby. This library conforms to WebSocket draft-75 and draft-76.
+email: frsyuki@users.sourceforge.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rev-websocket.rb
+- lib/rev/websocket.rb
+- lib/rev/websocket/spec.rb
+has_rdoc: true
+homepage: http://github.com/frsyuki/rev-websocket
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: WebSocket server based on Rev
+test_files: []
+