websocket-driver-0.6.3/0000755000175000017500000000000012643000111013361 5ustar aleealeewebsocket-driver-0.6.3/ext/0000755000175000017500000000000012643000111014161 5ustar aleealeewebsocket-driver-0.6.3/ext/websocket-driver/0000755000175000017500000000000012643000111017440 5ustar aleealeewebsocket-driver-0.6.3/ext/websocket-driver/WebsocketMaskService.java0000644000175000017500000000321112643000111024363 0ustar aleealeepackage com.jcoglan.websocket; import java.lang.Long; import java.io.IOException; import org.jruby.Ruby; import org.jruby.RubyClass; import org.jruby.RubyModule; import org.jruby.RubyObject; import org.jruby.RubyString; import org.jruby.anno.JRubyMethod; import org.jruby.runtime.ObjectAllocator; import org.jruby.runtime.ThreadContext; import org.jruby.runtime.builtin.IRubyObject; import org.jruby.runtime.load.BasicLibraryService; public class WebsocketMaskService implements BasicLibraryService { private Ruby runtime; public boolean basicLoad(Ruby runtime) throws IOException { this.runtime = runtime; RubyModule websocket = runtime.defineModule("WebSocket"); RubyClass webSocketMask = websocket.defineClassUnder("Mask", runtime.getObject(), new ObjectAllocator() { public IRubyObject allocate(Ruby runtime, RubyClass rubyClass) { return new WebsocketMask(runtime, rubyClass); } }); webSocketMask.defineAnnotatedMethods(WebsocketMask.class); return true; } public class WebsocketMask extends RubyObject { public WebsocketMask(final Ruby runtime, RubyClass rubyClass) { super(runtime, rubyClass); } @JRubyMethod public IRubyObject mask(ThreadContext context, IRubyObject payload, IRubyObject mask) { if (mask.isNil()) return payload; byte[] payload_a = ((RubyString)payload).getBytes(); byte[] mask_a = ((RubyString)mask).getBytes(); int i, n = payload_a.length; if (n == 0) return payload; for (i = 0; i < n; i++) { payload_a[i] ^= mask_a[i % 4]; } return RubyString.newStringNoCopy(runtime, payload_a); } } } websocket-driver-0.6.3/ext/websocket-driver/extconf.rb0000644000175000017500000000015412643000111021433 0ustar aleealeerequire 'mkmf' extension_name = 'websocket_mask' dir_config(extension_name) create_makefile(extension_name) websocket-driver-0.6.3/ext/websocket-driver/websocket_mask.c0000644000175000017500000000163612643000111022613 0ustar aleealee#include VALUE WebSocket = Qnil; VALUE WebSocketMask = Qnil; void Init_websocket_mask(); VALUE method_websocket_mask(VALUE self, VALUE payload, VALUE mask); void Init_websocket_mask() { WebSocket = rb_define_module("WebSocket"); WebSocketMask = rb_define_module_under(WebSocket, "Mask"); rb_define_singleton_method(WebSocketMask, "mask", method_websocket_mask, 2); } VALUE method_websocket_mask(VALUE self, VALUE payload, VALUE mask) { char *payload_s, *mask_s, *unmasked_s; long i, n; VALUE unmasked; if (mask == Qnil || RSTRING_LEN(mask) != 4) { return payload; } payload_s = RSTRING_PTR(payload); mask_s = RSTRING_PTR(mask); n = RSTRING_LEN(payload); unmasked = rb_str_new(0, n); unmasked_s = RSTRING_PTR(unmasked); for (i = 0; i < n; i++) { unmasked_s[i] = payload_s[i] ^ mask_s[i % 4]; } return unmasked; } websocket-driver-0.6.3/examples/0000755000175000017500000000000012643000111015177 5ustar aleealeewebsocket-driver-0.6.3/examples/tcp_server.rb0000644000175000017500000000117212643000111017701 0ustar aleealeerequire 'rubygems' require 'bundler/setup' require 'eventmachine' require 'websocket/driver' require 'permessage_deflate' module Connection def initialize @driver = WebSocket::Driver.server(self) @driver.add_extension(PermessageDeflate) @driver.on(:connect) { |e| @driver.start if WebSocket::Driver.websocket? @driver.env } @driver.on(:message) { |e| @driver.frame(e.data) } @driver.on(:close) { |e| close_connection_after_writing } end def receive_data(data) @driver.parse(data) end def write(data) send_data(data) end end EM.run { EM.start_server('127.0.0.1', ARGV[0], Connection) } websocket-driver-0.6.3/lib/0000755000175000017500000000000012643000111014127 5ustar aleealeewebsocket-driver-0.6.3/lib/websocket/0000755000175000017500000000000012643000111016115 5ustar aleealeewebsocket-driver-0.6.3/lib/websocket/driver.rb0000644000175000017500000001160112643000111017734 0ustar aleealee# Protocol references: # # * http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75 # * http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 # * http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-17 require 'base64' require 'digest/md5' require 'digest/sha1' require 'securerandom' require 'set' require 'stringio' require 'uri' require 'websocket/extensions' module WebSocket autoload :HTTP, File.expand_path('../http', __FILE__) class Driver root = File.expand_path('../driver', __FILE__) require 'websocket_mask' if RUBY_PLATFORM =~ /java/ require 'jruby' com.jcoglan.websocket.WebsocketMaskService.new.basicLoad(JRuby.runtime) end unless Mask.respond_to?(:mask) def Mask.mask(payload, mask) @instance ||= new @instance.mask(payload, mask) end end unless String.instance_methods.include?(:force_encoding) require root + '/utf8_match' end MAX_LENGTH = 0x3ffffff STATES = [:connecting, :open, :closing, :closed] ConnectEvent = Struct.new(nil) OpenEvent = Struct.new(nil) MessageEvent = Struct.new(:data) CloseEvent = Struct.new(:code, :reason) ProtocolError = Class.new(StandardError) URIError = Class.new(ArgumentError) ConfigurationError = Class.new(ArgumentError) autoload :Client, root + '/client' autoload :Draft75, root + '/draft75' autoload :Draft76, root + '/draft76' autoload :EventEmitter, root + '/event_emitter' autoload :Headers, root + '/headers' autoload :Hybi, root + '/hybi' autoload :Proxy, root + '/proxy' autoload :Server, root + '/server' autoload :StreamReader, root + '/stream_reader' include EventEmitter attr_reader :protocol, :ready_state def initialize(socket, options = {}) super() Driver.validate_options(options, [:max_length, :masking, :require_masking, :protocols]) @socket = socket @reader = StreamReader.new @options = options @max_length = options[:max_length] || MAX_LENGTH @headers = Headers.new @queue = [] @ready_state = 0 end def state return nil unless @ready_state >= 0 STATES[@ready_state] end def add_extension(extension) false end def set_header(name, value) return false unless @ready_state <= 0 @headers[name] = value true end def start return false unless @ready_state == 0 response = handshake_response return false unless response @socket.write(Driver.encode(response, :binary)) open unless @stage == -1 true end def text(message) frame(message) end def binary(message) false end def ping(*args) false end def pong(*args) false end def close(reason = nil, code = nil) return false unless @ready_state == 1 @ready_state = 3 emit(:close, CloseEvent.new(nil, nil)) true end private def open @ready_state = 1 @queue.each { |message| frame(*message) } @queue = [] emit(:open, OpenEvent.new) end def queue(message) @queue << message true end def self.client(socket, options = {}) Client.new(socket, options.merge(:masking => true)) end def self.server(socket, options = {}) Server.new(socket, options.merge(:require_masking => true)) end def self.rack(socket, options = {}) env = socket.env if env['HTTP_SEC_WEBSOCKET_VERSION'] Hybi.new(socket, options.merge(:require_masking => true)) elsif env['HTTP_SEC_WEBSOCKET_KEY1'] Draft76.new(socket, options) else Draft75.new(socket, options) end end def self.encode(string, encoding = nil) case string when Array then string = string.pack('C*') encoding ||= :binary when String then encoding ||= :utf8 end encodings = {:utf8 => 'UTF-8', :binary => 'ASCII-8BIT'} string.force_encoding(encodings[encoding]) if string.respond_to?(:force_encoding) return nil if encoding == :utf8 and not valid_utf8?(string) string end def self.validate_options(options, valid_keys) options.keys.each do |key| unless valid_keys.include?(key) raise ConfigurationError, "Unrecognized option: #{key.inspect}" end end end def self.valid_utf8?(string) if defined?(UTF8_MATCH) UTF8_MATCH =~ string ? true : false else string.valid_encoding? end end def self.websocket?(env) connection = env['HTTP_CONNECTION'] || '' upgrade = env['HTTP_UPGRADE'] || '' env['REQUEST_METHOD'] == 'GET' and connection.downcase.split(/ *, */).include?('upgrade') and upgrade.downcase == 'websocket' end end end websocket-driver-0.6.3/lib/websocket/http.rb0000644000175000017500000000051212643000111017417 0ustar aleealeemodule WebSocket module HTTP root = File.expand_path('../http', __FILE__) autoload :Headers, root + '/headers' autoload :Request, root + '/request' autoload :Response, root + '/response' def self.normalize_header(name) name.to_s.strip.downcase.gsub(/^http_/, '').gsub(/_/, '-') end end end websocket-driver-0.6.3/lib/websocket/driver/0000755000175000017500000000000012643000111017410 5ustar aleealeewebsocket-driver-0.6.3/lib/websocket/driver/proxy.rb0000644000175000017500000000331712643000111021122 0ustar aleealeemodule WebSocket class Driver class Proxy include EventEmitter PORTS = {'ws' => 80, 'wss' => 443} attr_reader :status, :headers def initialize(client, origin, options) super() @client = client @http = HTTP::Response.new @socket = client.instance_variable_get(:@socket) @origin = URI.parse(@socket.url) @url = URI.parse(origin) @options = options @state = 0 @headers = Headers.new @headers['Host'] = @origin.host + (@origin.port ? ":#{@origin.port}" : '') @headers['Connection'] = 'keep-alive' @headers['Proxy-Connection'] = 'keep-alive' if @url.user auth = Base64.strict_encode64([@url.user, @url.password] * ':') @headers['Proxy-Authorization'] = 'Basic ' + auth end end def set_header(name, value) return false unless @state == 0 @headers[name] = value true end def start return false unless @state == 0 @state = 1 port = @origin.port || PORTS[@origin.scheme] start = "CONNECT #{@origin.host}:#{port} HTTP/1.1" headers = [start, @headers.to_s, ''] @socket.write(Driver.encode(headers.join("\r\n"), :binary)) true end def parse(chunk) @http.parse(chunk) return unless @http.complete? @status = @http.code @headers = Headers.new(@http.headers) if @status == 200 emit(:connect, ConnectEvent.new) else message = "Can't establish a connection to the server at #{@socket.url}" emit(:error, ProtocolError.new(message)) end end end end end websocket-driver-0.6.3/lib/websocket/driver/headers.rb0000644000175000017500000000153412643000111021353 0ustar aleealeemodule WebSocket class Driver class Headers ALLOWED_DUPLICATES = %w[set-cookie set-cookie2 warning www-authenticate] def initialize(received = {}) @raw = received clear @received = {} @raw.each { |k,v| @received[HTTP.normalize_header(k)] = v } end def clear @sent = Set.new @lines = [] end def [](name) @received[HTTP.normalize_header(name)] end def []=(name, value) return if value.nil? key = HTTP.normalize_header(name) return unless @sent.add?(key) or ALLOWED_DUPLICATES.include?(key) @lines << "#{name.strip}: #{value.to_s.strip}\r\n" end def inspect @raw.inspect end def to_h @raw.dup end def to_s @lines.join('') end end end end websocket-driver-0.6.3/lib/websocket/driver/client.rb0000644000175000017500000000764612643000111021230 0ustar aleealeemodule WebSocket class Driver class Client < Hybi VALID_SCHEMES = %w[ws wss] def self.generate_key Base64.strict_encode64(SecureRandom.random_bytes(16)) end attr_reader :status, :headers def initialize(socket, options = {}) super @ready_state = -1 @key = Client.generate_key @accept = Hybi.generate_accept(@key) @http = HTTP::Response.new uri = URI.parse(@socket.url) unless VALID_SCHEMES.include?(uri.scheme) raise URIError, "#{socket.url} is not a valid WebSocket URL" end host = uri.host + (uri.port ? ":#{uri.port}" : '') path = (uri.path == '') ? '/' : uri.path @pathname = path + (uri.query ? '?' + uri.query : '') @headers['Host'] = host @headers['Upgrade'] = 'websocket' @headers['Connection'] = 'Upgrade' @headers['Sec-WebSocket-Key'] = @key @headers['Sec-WebSocket-Version'] = '13' if @protocols.size > 0 @headers['Sec-WebSocket-Protocol'] = @protocols * ', ' end if uri.user auth = Base64.strict_encode64([uri.user, uri.password] * ':') @headers['Authorization'] = 'Basic ' + auth end end def version 'hybi-13' end def proxy(origin, options = {}) Proxy.new(self, origin, options) end def start return false unless @ready_state == -1 @socket.write(Driver.encode(handshake_request, :binary)) @ready_state = 0 true end def parse(chunk) return if @ready_state == 3 return super if @ready_state > 0 @http.parse(chunk) return fail_handshake('Invalid HTTP response') if @http.error? return unless @http.complete? validate_handshake return if @ready_state == 3 open parse(@http.body) end private def handshake_request extensions = @extensions.generate_offer @headers['Sec-WebSocket-Extensions'] = extensions if extensions start = "GET #{@pathname} HTTP/1.1" headers = [start, @headers.to_s, ''] headers.join("\r\n") end def fail_handshake(message) message = "Error during WebSocket handshake: #{message}" @ready_state = 3 emit(:error, ProtocolError.new(message)) emit(:close, CloseEvent.new(ERRORS[:protocol_error], message)) end def validate_handshake @status = @http.code @headers = Headers.new(@http.headers) unless @http.code == 101 return fail_handshake("Unexpected response code: #{@http.code}") end upgrade = @http['Upgrade'] || '' connection = @http['Connection'] || '' accept = @http['Sec-WebSocket-Accept'] || '' protocol = @http['Sec-WebSocket-Protocol'] || '' if upgrade == '' return fail_handshake("'Upgrade' header is missing") elsif upgrade.downcase != 'websocket' return fail_handshake("'Upgrade' header value is not 'WebSocket'") end if connection == '' return fail_handshake("'Connection' header is missing") elsif connection.downcase != 'upgrade' return fail_handshake("'Connection' header value is not 'Upgrade'") end unless accept == @accept return fail_handshake('Sec-WebSocket-Accept mismatch') end unless protocol == '' if @protocols.include?(protocol) @protocol = protocol else return fail_handshake('Sec-WebSocket-Protocol mismatch') end end begin @extensions.activate(@headers['Sec-WebSocket-Extensions']) rescue ::WebSocket::Extensions::ExtensionError => error return fail_handshake(error.message) end end end end end websocket-driver-0.6.3/lib/websocket/driver/event_emitter.rb0000644000175000017500000000222412643000111022607 0ustar aleealeemodule WebSocket class Driver module EventEmitter def initialize @listeners = Hash.new { |h,k| h[k] = [] } end def add_listener(event, callable = nil, &block) listener = callable || block @listeners[event.to_s] << listener listener end def on(event, callable = nil, &block) if callable add_listener(event, callable) else add_listener(event, &block) end end def remove_listener(event, callable = nil, &block) listener = callable || block @listeners[event.to_s].delete(listener) listener end def remove_all_listeners(event = nil) if event @listeners.delete(event.to_s) else @listeners.clear end end def emit(event, *args) @listeners[event.to_s].dup.each do |listener| listener.call(*args) end end def listener_count(event) return 0 unless @listeners.has_key?(event.to_s) @listeners[event.to_s].size end def listeners(event) @listeners[event.to_s] end end end end websocket-driver-0.6.3/lib/websocket/driver/hybi.rb0000644000175000017500000002767712643000111020713 0ustar aleealeemodule WebSocket class Driver class Hybi < Driver root = File.expand_path('../hybi', __FILE__) autoload :Frame, root + '/frame' autoload :Message, root + '/message' def self.generate_accept(key) Base64.strict_encode64(Digest::SHA1.digest(key + GUID)) end GUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11' BYTE = 0b11111111 FIN = MASK = 0b10000000 RSV1 = 0b01000000 RSV2 = 0b00100000 RSV3 = 0b00010000 OPCODE = 0b00001111 LENGTH = 0b01111111 OPCODES = { :continuation => 0, :text => 1, :binary => 2, :close => 8, :ping => 9, :pong => 10 } OPCODE_CODES = OPCODES.values MESSAGE_OPCODES = OPCODES.values_at(:continuation, :text, :binary) OPENING_OPCODES = OPCODES.values_at(:text, :binary) ERRORS = { :normal_closure => 1000, :going_away => 1001, :protocol_error => 1002, :unacceptable => 1003, :encoding_error => 1007, :policy_violation => 1008, :too_large => 1009, :extension_error => 1010, :unexpected_condition => 1011 } ERROR_CODES = ERRORS.values DEFAULT_ERROR_CODE = 1000 MIN_RESERVED_ERROR = 3000 MAX_RESERVED_ERROR = 4999 PACK_FORMATS = {2 => 'n', 8 => 'Q>'} def initialize(socket, options = {}) super @extensions = ::WebSocket::Extensions.new @stage = 0 @masking = options[:masking] @protocols = options[:protocols] || [] @protocols = @protocols.strip.split(/ *, */) if String === @protocols @require_masking = options[:require_masking] @ping_callbacks = {} return unless @socket.respond_to?(:env) sec_key = @socket.env['HTTP_SEC_WEBSOCKET_KEY'] protos = @socket.env['HTTP_SEC_WEBSOCKET_PROTOCOL'] @headers['Upgrade'] = 'websocket' @headers['Connection'] = 'Upgrade' @headers['Sec-WebSocket-Accept'] = Hybi.generate_accept(sec_key) if protos = @socket.env['HTTP_SEC_WEBSOCKET_PROTOCOL'] protos = protos.split(/ *, */) if String === protos @protocol = protos.find { |p| @protocols.include?(p) } @headers['Sec-WebSocket-Protocol'] = @protocol if @protocol end end def version "hybi-#{@socket.env['HTTP_SEC_WEBSOCKET_VERSION']}" end def add_extension(extension) @extensions.add(extension) true end def parse(chunk) @reader.put(chunk) buffer = true while buffer case @stage when 0 then buffer = @reader.read(1) parse_opcode(buffer.getbyte(0)) if buffer when 1 then buffer = @reader.read(1) parse_length(buffer.getbyte(0)) if buffer when 2 then buffer = @reader.read(@frame.length_bytes) parse_extended_length(buffer) if buffer when 3 then buffer = @reader.read(4) if buffer @stage = 4 @frame.masking_key = buffer end when 4 then buffer = @reader.read(@frame.length) if buffer @stage = 0 emit_frame(buffer) end else buffer = nil end end end def text(message) frame(message, :text) end def binary(message) frame(message, :binary) end def ping(message = '', &callback) @ping_callbacks[message] = callback if callback frame(message, :ping) end def pong(message = '') frame(message, :pong) end def close(reason = nil, code = nil) reason ||= '' code ||= ERRORS[:normal_closure] if @ready_state <= 0 @ready_state = 3 emit(:close, CloseEvent.new(code, reason)) true elsif @ready_state == 1 frame(reason, :close, code) @ready_state = 2 true else false end end def frame(buffer, type = nil, code = nil) return queue([buffer, type, code]) if @ready_state <= 0 return false unless @ready_state == 1 message = Message.new frame = Frame.new is_text = String === buffer message.rsv1 = message.rsv2 = message.rsv3 = false message.opcode = OPCODES[type || (is_text ? :text : :binary)] payload = is_text ? buffer.bytes.to_a : buffer payload = [code].pack(PACK_FORMATS[2]).bytes.to_a + payload if code message.data = payload.pack('C*') if MESSAGE_OPCODES.include?(message.opcode) message = @extensions.process_outgoing_message(message) end frame.final = true frame.rsv1 = message.rsv1 frame.rsv2 = message.rsv2 frame.rsv3 = message.rsv3 frame.opcode = message.opcode frame.masked = !!@masking frame.masking_key = SecureRandom.random_bytes(4) if frame.masked frame.length = message.data.bytesize frame.payload = message.data send_frame(frame) true rescue ::WebSocket::Extensions::ExtensionError => error fail(:extension_error, error.message) end private def send_frame(frame) length = frame.length header = (length <= 125) ? 2 : (length <= 65535 ? 4 : 10) offset = header + (frame.masked ? 4 : 0) buffer = [] masked = frame.masked ? MASK : 0 buffer[0] = (frame.final ? FIN : 0) | (frame.rsv1 ? RSV1 : 0) | (frame.rsv2 ? RSV2 : 0) | (frame.rsv3 ? RSV3 : 0) | frame.opcode if length <= 125 buffer[1] = masked | length elsif length <= 65535 buffer[1] = masked | 126 buffer[2..3] = [length].pack(PACK_FORMATS[2]).bytes.to_a else buffer[1] = masked | 127 buffer[2..9] = [length].pack(PACK_FORMATS[8]).bytes.to_a end if frame.masked buffer.concat(frame.masking_key.bytes.to_a) buffer.concat(Mask.mask(frame.payload, frame.masking_key).bytes.to_a) else buffer.concat(frame.payload.bytes.to_a) end @socket.write(buffer.pack('C*')) end def handshake_response begin extensions = @extensions.generate_response(@socket.env['HTTP_SEC_WEBSOCKET_EXTENSIONS']) rescue => error fail(:protocol_error, error.message) return nil end @headers['Sec-WebSocket-Extensions'] = extensions if extensions start = 'HTTP/1.1 101 Switching Protocols' headers = [start, @headers.to_s, ''] headers.join("\r\n") end def shutdown(code, reason, error = false) @frame = @message = nil @stage = 5 @extensions.close frame(reason, :close, code) if @ready_state < 2 @ready_state = 3 emit(:error, ProtocolError.new(reason)) if error emit(:close, CloseEvent.new(code, reason)) end def fail(type, message) return if @ready_state > 1 shutdown(ERRORS[type], message, true) end def parse_opcode(octet) rsvs = [RSV1, RSV2, RSV3].map { |rsv| (octet & rsv) == rsv } @frame = Frame.new @frame.final = (octet & FIN) == FIN @frame.rsv1 = rsvs[0] @frame.rsv2 = rsvs[1] @frame.rsv3 = rsvs[2] @frame.opcode = (octet & OPCODE) @stage = 1 unless @extensions.valid_frame_rsv?(@frame) return fail(:protocol_error, "One or more reserved bits are on: reserved1 = #{@frame.rsv1 ? 1 : 0}" + ", reserved2 = #{@frame.rsv2 ? 1 : 0 }" + ", reserved3 = #{@frame.rsv3 ? 1 : 0 }") end unless OPCODES.values.include?(@frame.opcode) return fail(:protocol_error, "Unrecognized frame opcode: #{@frame.opcode}") end unless MESSAGE_OPCODES.include?(@frame.opcode) or @frame.final return fail(:protocol_error, "Received fragmented control frame: opcode = #{@frame.opcode}") end if @message and OPENING_OPCODES.include?(@frame.opcode) return fail(:protocol_error, 'Received new data frame but previous continuous frame is unfinished') end end def parse_length(octet) @frame.masked = (octet & MASK) == MASK @frame.length = (octet & LENGTH) if @frame.length >= 0 and @frame.length <= 125 @stage = @frame.masked ? 3 : 4 return unless check_frame_length else @stage = 2 @frame.length_bytes = (@frame.length == 126) ? 2 : 8 end if @require_masking and not @frame.masked return fail(:unacceptable, 'Received unmasked frame but masking is required') end end def parse_extended_length(buffer) @frame.length = buffer.unpack(PACK_FORMATS[buffer.bytesize]).first @stage = @frame.masked ? 3 : 4 unless MESSAGE_OPCODES.include?(@frame.opcode) or @frame.length <= 125 return fail(:protocol_error, "Received control frame having too long payload: #{@frame.length}") end return unless check_frame_length end def check_frame_length length = @message ? @message.data.bytesize : 0 if length + @frame.length > @max_length fail(:too_large, 'WebSocket frame length too large') false else true end end def emit_frame(buffer) frame = @frame opcode = frame.opcode payload = frame.payload = Mask.mask(buffer, @frame.masking_key) bytesize = payload.bytesize bytes = payload.bytes.to_a @frame = nil case opcode when OPCODES[:continuation] then return fail(:protocol_error, 'Received unexpected continuation frame') unless @message @message << frame when OPCODES[:text], OPCODES[:binary] then @message = Message.new @message << frame when OPCODES[:close] then code = (bytesize >= 2) ? payload.unpack(PACK_FORMATS[2]).first : nil reason = (bytesize > 2) ? Driver.encode(bytes[2..-1] || [], :utf8) : nil unless (bytesize == 0) or (code && code >= MIN_RESERVED_ERROR && code <= MAX_RESERVED_ERROR) or ERROR_CODES.include?(code) code = ERRORS[:protocol_error] end if bytesize > 125 or (bytesize > 2 and reason.nil?) code = ERRORS[:protocol_error] end shutdown(code || DEFAULT_ERROR_CODE, reason || '') when OPCODES[:ping] then frame(payload, :pong) when OPCODES[:pong] then message = Driver.encode(payload, :utf8) callback = @ping_callbacks[message] @ping_callbacks.delete(message) callback.call if callback end emit_message if frame.final and MESSAGE_OPCODES.include?(opcode) end def emit_message message = @extensions.process_incoming_message(@message) @message = nil payload = message.data case message.opcode when OPCODES[:text] then payload = Driver.encode(payload, :utf8) when OPCODES[:binary] payload = payload.bytes.to_a end if payload emit(:message, MessageEvent.new(payload)) else fail(:encoding_error, 'Could not decode a text frame as UTF-8') end rescue ::WebSocket::Extensions::ExtensionError => error fail(:extension_error, error.message) end end end end websocket-driver-0.6.3/lib/websocket/driver/hybi/0000755000175000017500000000000012643000111020343 5ustar aleealeewebsocket-driver-0.6.3/lib/websocket/driver/hybi/frame.rb0000644000175000017500000000063112643000111021762 0ustar aleealeemodule WebSocket class Driver class Hybi class Frame attr_accessor :final, :rsv1, :rsv2, :rsv3, :opcode, :masked, :masking_key, :length_bytes, :length, :payload end end end end websocket-driver-0.6.3/lib/websocket/driver/hybi/message.rb0000644000175000017500000000117112643000111022314 0ustar aleealeemodule WebSocket class Driver class Hybi class Message attr_accessor :rsv1, :rsv2, :rsv3, :opcode, :data def initialize @rsv1 = false @rsv2 = false @rsv3 = false @opcode = nil @data = Driver.encode('', :binary) end def <<(frame) @rsv1 ||= frame.rsv1 @rsv2 ||= frame.rsv2 @rsv3 ||= frame.rsv3 @opcode ||= frame.opcode @data << frame.payload end end end end end websocket-driver-0.6.3/lib/websocket/driver/stream_reader.rb0000644000175000017500000000213412643000111022552 0ustar aleealeemodule WebSocket class Driver class StreamReader # Try to minimise the number of reallocations done: MINIMUM_AUTOMATIC_PRUNE_OFFSET = 128 def initialize @buffer = Driver.encode('', :binary) @offset = 0 end def put(chunk) return unless chunk and chunk.bytesize > 0 @buffer << Driver.encode(chunk, :binary) end # Read bytes from the data: def read(length) return nil if (@offset + length) > @buffer.bytesize chunk = @buffer.byteslice(@offset, length) @offset += chunk.bytesize prune if @offset > MINIMUM_AUTOMATIC_PRUNE_OFFSET return chunk end def each_byte prune @buffer.each_byte do |octet| @offset += 1 yield octet end end private def prune buffer_size = @buffer.bytesize if @offset > buffer_size @buffer = Driver.encode('', :binary) else @buffer = @buffer.byteslice(@offset, buffer_size - @offset) end @offset = 0 end end end end websocket-driver-0.6.3/lib/websocket/driver/draft75.rb0000644000175000017500000000461712643000111021221 0ustar aleealeemodule WebSocket class Driver class Draft75 < Driver def initialize(socket, options = {}) super @stage = 0 @headers['Upgrade'] = 'WebSocket' @headers['Connection'] = 'Upgrade' @headers['WebSocket-Origin'] = @socket.env['HTTP_ORIGIN'] @headers['WebSocket-Location'] = @socket.url end def version 'hixie-75' end def close(reason = nil, code = nil) return false if @ready_state == 3 @ready_state = 3 emit(:close, CloseEvent.new(nil, nil)) true end def parse(chunk) return if @ready_state > 1 @reader.put(chunk) @reader.each_byte do |octet| case @stage when -1 then @body << octet send_handshake_body when 0 then parse_leading_byte(octet) when 1 then @length = (octet & 0x7F) + 128 * @length if @closing and @length.zero? return close elsif (octet & 0x80) != 0x80 if @length.zero? @stage = 0 else @skipped = 0 @stage = 2 end end when 2 then if octet == 0xFF @stage = 0 emit(:message, MessageEvent.new(Driver.encode(@buffer, :utf8))) else if @length @skipped += 1 @stage = 0 if @skipped == @length else @buffer << octet return close if @buffer.size > @max_length end end end end end def frame(buffer, type = nil, error_type = nil) return queue([buffer, type, error_type]) if @ready_state == 0 frame = [0x00, buffer, 0xFF].pack('CA*C') @socket.write(frame) true end private def handshake_response start = 'HTTP/1.1 101 Web Socket Protocol Handshake' headers = [start, @headers.to_s, ''] headers.join("\r\n") end def parse_leading_byte(octet) if (octet & 0x80) == 0x80 @length = 0 @stage = 1 else @length = nil @skipped = nil @buffer = [] @stage = 2 end end end end end websocket-driver-0.6.3/lib/websocket/driver/utf8_match.rb0000644000175000017500000000053112643000111021776 0ustar aleealeemodule WebSocket class Driver # http://www.w3.org/International/questions/qa-forms-utf-8.en.php UTF8_MATCH = /^([\x00-\x7F]|[\xC2-\xDF][\x80-\xBF]|\xE0[\xA0-\xBF][\x80-\xBF]|[\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}|\xED[\x80-\x9F][\x80-\xBF]|\xF0[\x90-\xBF][\x80-\xBF]{2}|[\xF1-\xF3][\x80-\xBF]{3}|\xF4[\x80-\x8F][\x80-\xBF]{2})*$/ end end websocket-driver-0.6.3/lib/websocket/driver/draft76.rb0000644000175000017500000000454212643000111021217 0ustar aleealeemodule WebSocket class Driver class Draft76 < Draft75 BODY_SIZE = 8 def initialize(socket, options = {}) super input = @socket.env['rack.input'] @stage = -1 @body = Driver.encode(input ? input.read : '', :binary) @headers.clear @headers['Upgrade'] = 'WebSocket' @headers['Connection'] = 'Upgrade' @headers['Sec-WebSocket-Origin'] = @socket.env['HTTP_ORIGIN'] @headers['Sec-WebSocket-Location'] = @socket.url end def version 'hixie-76' end def start return false unless super send_handshake_body true end def close(reason = nil, code = nil) return false if @ready_state == 3 @socket.write([0xFF, 0x00].pack('C*')) @ready_state = 3 emit(:close, CloseEvent.new(nil, nil)) true end private def handshake_response env = @socket.env key1 = env['HTTP_SEC_WEBSOCKET_KEY1'] number1 = number_from_key(key1) spaces1 = spaces_in_key(key1) key2 = env['HTTP_SEC_WEBSOCKET_KEY2'] number2 = number_from_key(key2) spaces2 = spaces_in_key(key2) if number1 % spaces1 != 0 or number2 % spaces2 != 0 emit(:error, ProtocolError.new('Client sent invalid Sec-WebSocket-Key headers')) close return nil end @key_values = [number1 / spaces1, number2 / spaces2] start = 'HTTP/1.1 101 WebSocket Protocol Handshake' headers = [start, @headers.to_s, ''] headers.join("\r\n") end def handshake_signature return nil unless @body.bytesize >= BODY_SIZE head = @body[0...BODY_SIZE] Digest::MD5.digest((@key_values + [head]).pack('N2A*')) end def send_handshake_body return unless signature = handshake_signature @socket.write(Driver.encode(signature, :binary)) @stage = 0 open parse(@body[BODY_SIZE..-1]) if @body.bytesize > BODY_SIZE end def parse_leading_byte(octet) return super unless octet == 0xFF @closing = true @length = 0 @stage = 1 end def number_from_key(key) key.scan(/[0-9]/).join('').to_i(10) end def spaces_in_key(key) key.scan(/ /).size end end end end websocket-driver-0.6.3/lib/websocket/driver/server.rb0000644000175000017500000000347112643000111021250 0ustar aleealeemodule WebSocket class Driver class Server < Driver EVENTS = %w[open message error close] def initialize(socket, options = {}) super @http = HTTP::Request.new @delegate = nil end def env @http.complete? ? @http.env : nil end def url return nil unless e = env url = "ws://#{e['HTTP_HOST']}" url << e['PATH_INFO'] url << "?#{e['QUERY_STRING']}" unless e['QUERY_STRING'] == '' url end %w[add_extension set_header start frame text binary ping close].each do |method| define_method(method) do |*args, &block| if @delegate @delegate.__send__(method, *args, &block) else @queue << [method, args, block] true end end end %w[protocol version].each do |method| define_method(method) do @delegate && @delegate.__send__(method) end end def parse(chunk) return @delegate.parse(chunk) if @delegate @http.parse(chunk) return fail_request('Invalid HTTP request') if @http.error? return unless @http.complete? @delegate = Driver.rack(self, @options) open EVENTS.each do |event| @delegate.on(event) { |e| emit(event, e) } end emit(:connect, ConnectEvent.new) end def write(buffer) @socket.write(Driver.encode(buffer, :binary)) end private def fail_request(message) emit(:error, ProtocolError.new(message)) emit(:close, CloseEvent.new(Hybi::ERRORS[:protocol_error], message)) end def open @queue.each do |method, args, block| @delegate.__send__(method, *args, &block) end @queue = [] end end end end websocket-driver-0.6.3/lib/websocket/http/0000755000175000017500000000000012643000111017074 5ustar aleealeewebsocket-driver-0.6.3/lib/websocket/http/headers.rb0000644000175000017500000000534512643000111021043 0ustar aleealeemodule WebSocket module HTTP module Headers MAX_LINE_LENGTH = 4096 CR = 0x0D LF = 0x0A # RFC 2616 grammar rules: # # CHAR = # # CTL = # # SP = # # HT = # # token = 1* # # separators = "(" | ")" | "<" | ">" | "@" # | "," | ";" | ":" | "\" | <"> # | "/" | "[" | "]" | "?" | "=" # | "{" | "}" | SP | HT # # Or, as redefined in RFC 7230: # # token = 1*tchar # # tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" # / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~" # / DIGIT / ALPHA # ; any VCHAR, except delimiters HEADER_LINE = /^([!#\$%&'\*\+\-\.\^_`\|~0-9a-z]+):\s*([\x20-\x7e]*?)\s*$/i attr_reader :headers def initialize @buffer = [] @headers = {} @stage = 0 end def complete? @stage == 2 end def error? @stage == -1 end def parse(chunk) chunk.each_byte do |octet| if octet == LF and @stage < 2 @buffer.pop if @buffer.last == CR if @buffer.empty? complete if @stage == 1 else result = case @stage when 0 then start_line(string_buffer) when 1 then header_line(string_buffer) end if result @stage = 1 else error end end @buffer = [] else @buffer << octet if @stage >= 0 error if @stage < 2 and @buffer.size > MAX_LINE_LENGTH end end @env['rack.input'] = StringIO.new(string_buffer) if @env end private def complete @stage = 2 end def error @stage = -1 end def header_line(line) return false unless parsed = line.scan(HEADER_LINE).first key = HTTP.normalize_header(parsed[0]) value = parsed[1].strip if @headers.has_key?(key) @headers[key] << ', ' << value else @headers[key] = value end true end def string_buffer @buffer.pack('C*') end end end end websocket-driver-0.6.3/lib/websocket/http/request.rb0000644000175000017500000000217312643000111021114 0ustar aleealeemodule WebSocket module HTTP class Request include Headers REQUEST_LINE = /^(OPTIONS|GET|HEAD|POST|PUT|DELETE|TRACE|CONNECT) ([\x21-\x7e]+) (HTTP\/[0-9]+\.[0-9]+)$/ REQUEST_TARGET = /^(.*?)(\?(.*))?$/ RESERVED_HEADERS = %w[content-length content-type] attr_reader :env private def start_line(line) return false unless parsed = line.scan(REQUEST_LINE).first target = parsed[1].scan(REQUEST_TARGET).first @env = { 'REQUEST_METHOD' => parsed[0], 'SCRIPT_NAME' => '', 'PATH_INFO' => target[0], 'QUERY_STRING' => target[2] || '' } true end def complete super @headers.each do |name, value| rack_name = name.upcase.gsub(/-/, '_') rack_name = "HTTP_#{rack_name}" unless RESERVED_HEADERS.include?(name) @env[rack_name] = value end if host = @env['HTTP_HOST'] uri = URI.parse("http://#{host}") @env['SERVER_NAME'] = uri.host @env['SERVER_PORT'] = uri.port.to_s end end end end end websocket-driver-0.6.3/lib/websocket/http/response.rb0000644000175000017500000000074112643000111021261 0ustar aleealeemodule WebSocket module HTTP class Response include Headers STATUS_LINE = /^(HTTP\/[0-9]+\.[0-9]+) ([0-9]{3}) ([\x20-\x7e]+)$/ attr_reader :code def [](name) @headers[HTTP.normalize_header(name)] end def body @buffer.pack('C*') end private def start_line(line) return false unless parsed = line.scan(STATUS_LINE).first @code = parsed[1].to_i true end end end end websocket-driver-0.6.3/lib/websocket/websocket_mask.rb0000644000175000017500000000010412643000111021436 0ustar aleealee# Load C native extension require "websocket-driver/websocket_mask" websocket-driver-0.6.3/CHANGELOG.md0000644000175000017500000000617712643000111015205 0ustar aleealee### 0.6.3 / 2015-11-06 * Reject draft-76 handshakes if their Sec-WebSocket-Key headers are invalid * Throw a more helpful error if a client is created with an invalid URL ### 0.6.2 / 2015-07-18 * When the peer sends a close frame with no error code, emit 1000 ### 0.6.1 / 2015-07-13 * Fix how events are stored in `EventEmitter` to fix a backward-compatibility violation introduced in the last release * Use the `Array#pack` and `String#unpack` methods for reading/writing numbers to buffers rather than including duplicate logic for this ### 0.6.0 / 2015-07-08 * Use `SecureRandom` to generate the `Sec-WebSocket-Key` header * Allow the parser to recover cleanly if event listeners raise an error * Let the `on()` method take a lambda as a positional argument rather than a block * Add a `pong` method for sending unsolicited pong frames ### 0.5.4 / 2015-03-29 * Don't emit extra close frames if we receive a close frame after we already sent one * Fail the connection when the driver receives an invalid `Sec-WebSocket-Extensions` header ### 0.5.3 / 2015-02-22 * Don't treat incoming data as WebSocket frames if a client driver is closed before receiving the server handshake ### 0.5.2 / 2015-02-19 * Don't emit multiple `error` events ### 0.5.1 / 2014-12-18 * Don't allow drivers to be created with unrecognized options ### 0.5.0 / 2014-12-13 * Support protocol extensions via the websocket-extensions module ### 0.4.0 / 2014-11-08 * Support connection via HTTP proxies using `CONNECT` ### 0.3.5 / 2014-10-04 * Fix bug where the `Server` driver doesn't pass `ping` callbacks to its delegate * Fix an arity error when calling `fail_request` * Allow `close` to be called before `start` to close the driver ### 0.3.4 / 2014-07-06 * Don't hold references to frame buffers after a message has been emitted * Make sure that `protocol` and `version` are exposed properly by the TCP driver * Correct HTTP header parsing based on RFC 7230; header names cannot contain backslashes ### 0.3.3 / 2014-04-24 * Fix problems with loading C and Java native extension code * Correct the acceptable characters used in the HTTP parser * Correct the draft-76 status line reason phrase ### 0.3.2 / 2013-12-29 * Expand `max_length` to cover sequences of continuation frames and `draft-{75,76}` * Decrease default maximum frame buffer size to 64MB * Stop parsing when the protocol enters a failure mode, to save CPU cycles ### 0.3.1 / 2013-12-03 * Add a `max_length` option to limit allowed frame size ### 0.3.0 / 2013-09-09 * Support client URLs with Basic Auth credentials ### 0.2.3 / 2013-08-04 * Fix bug in EventEmitter#emit when listeners are removed ### 0.2.2 / 2013-08-04 * Fix bug in EventEmitter#listener_count for unregistered events ### 0.2.1 / 2013-07-05 * Queue sent messages if the client has not begun trying to connect * Encode all strings sent to I/O as `ASCII-8BIT` ### 0.2.0 / 2013-05-12 * Add API for setting and reading headers * Add Driver.server() method for getting a driver for TCP servers ### 0.1.0 / 2013-05-04 * First stable release ### 0.0.0 / 2013-04-22 * First release * Proof of concept for people to try out * Might be unstable websocket-driver-0.6.3/README.md0000644000175000017500000003277712643000111014660 0ustar aleealee# websocket-driver [![Build Status](https://travis-ci.org/faye/websocket-driver-ruby.svg)](https://travis-ci.org/faye/websocket-driver-ruby) This module provides a complete implementation of the WebSocket protocols that can be hooked up to any TCP library. It aims to simplify things by decoupling the protocol details from the I/O layer, such that users only need to implement code to stream data in and out of it without needing to know anything about how the protocol actually works. Think of it as a complete WebSocket system with pluggable I/O. Due to this design, you get a lot of things for free. In particular, if you hook this module up to some I/O object, it will do all of this for you: * Select the correct server-side driver to talk to the client * Generate and send both server- and client-side handshakes * Recognize when the handshake phase completes and the WS protocol begins * Negotiate subprotocol selection based on `Sec-WebSocket-Protocol` * Negotiate and use extensions via the [websocket-extensions](https://github.com/faye/websocket-extensions-ruby) module * Buffer sent messages until the handshake process is finished * Deal with proxies that defer delivery of the draft-76 handshake body * Notify you when the socket is open and closed and when messages arrive * Recombine fragmented messages * Dispatch text, binary, ping, pong and close frames * Manage the socket-closing handshake process * Automatically reply to ping frames with a matching pong * Apply masking to messages sent by the client This library was originally extracted from the [Faye](http://faye.jcoglan.com) project but now aims to provide simple WebSocket support for any Ruby server or I/O system. ## Installation ``` $ gem install websocket-driver ``` ## Usage To build either a server-side or client-side socket, the only requirement is that you supply a `socket` object with these methods: * `socket.url` - returns the full URL of the socket as a string. * `socket.write(string)` - writes the given string to a TCP stream. Server-side sockets require one additional method: * `socket.env` - returns a Rack-style env hash that will contain some of the following fields. Their values are strings containing the value of the named header, unless stated otherwise. * `HTTP_CONNECTION` * `HTTP_HOST` * `HTTP_ORIGIN` * `HTTP_SEC_WEBSOCKET_EXTENSIONS` * `HTTP_SEC_WEBSOCKET_KEY` * `HTTP_SEC_WEBSOCKET_KEY1` * `HTTP_SEC_WEBSOCKET_KEY2` * `HTTP_SEC_WEBSOCKET_PROTOCOL` * `HTTP_SEC_WEBSOCKET_VERSION` * `HTTP_UPGRADE` * `rack.input`, an `IO` object representing the request body * `REQUEST_METHOD`, the request's HTTP verb ### Server-side with Rack To handle a server-side WebSocket connection, you need to check whether the request is a WebSocket handshake, and if so create a protocol driver for it. You must give the driver an object with the `env`, `url` and `write` methods. A simple example might be: ```ruby require 'websocket/driver' require 'eventmachine' class WS attr_reader :env, :url def initialize(env) @env = env secure = Rack::Request.new(env).ssl? scheme = secure ? 'wss:' : 'ws:' @url = scheme + '//' + env['HTTP_HOST'] + env['REQUEST_URI'] @driver = WebSocket::Driver.rack(self) env['rack.hijack'].call @io = env['rack.hijack_io'] EM.attach(@io, Reader) { |conn| conn.driver = @driver } @driver.start end def write(string) @io.write(string) end module Reader attr_writer :driver def receive_data(string) @driver.parse(string) end end end ``` To explain what's going on here: the `WS` class implements the `env`, `url` and `write(string)` methods as required. When instantiated with a Rack environment, it stores the environment and infers the complete URL from it. Having set up the `env` and `url`, it asks `WebSocket::Driver` for a server-side driver for the socket. Then it uses the Rack hijack API to gain access to the TCP stream, and uses EventMachine to stream in incoming data from the client, handing incoming data off to the driver for parsing. Finally, we tell the driver to `start`, which will begin sending the handshake response. This will invoke the `WS#write` method, which will send the response out over the TCP socket. Having defined this class we could use it like this when handling a request: ```ruby if WebSocket::Driver.websocket?(env) socket = WS.new(env) end ``` The driver API is described in full below. ### Server-side with TCP You can also handle WebSocket connections in a bare TCP server, if you're not using Rack and don't want to implement HTTP parsing yourself. For this, your socket object only needs a `write` method. The driver will emit a `:connect` event when a request is received, and at this point you can detect whether it's a WebSocket and handle it as such. Here's an example using an EventMachine TCP server. ```ruby module Connection def initialize @driver = WebSocket::Driver.server(self) @driver.on :connect, -> (event) do if WebSocket::Driver.websocket?(@driver.env) @driver.start else # handle other HTTP requests end end @driver.on :message, -> (e) { @driver.text(e.data) } @driver.on :close, -> (e) { close_connection_after_writing } end def receive_data(data) @driver.parse(data) end def write(data) send_data(data) end end EM.run { EM.start_server('127.0.0.1', 4180, Connection) } ``` In the `:connect` event, `@driver.env` is a Rack env representing the request. If the request has a body, it will be in the `@driver.env['rack.input']` stream, but only as much of the body as you have so far routed to it using the `parse` method. ### Client-side Similarly, to implement a WebSocket client you need an object with `url` and `write` methods. Once you have one such object, you ask for a driver for it: ```ruby driver = WebSocket::Driver.client(socket) ``` After this you use the driver API as described below to process incoming data and send outgoing data. Client drivers have two additional methods for reading the HTTP data that was sent back by the server: * `driver.status` - the integer value of the HTTP status code * `driver.headers` - a hash-like object containing the response headers ### HTTP Proxies The client driver supports connections via HTTP proxies using the `CONNECT` method. Instead of sending the WebSocket handshake immediately, it will send a `CONNECT` request, wait for a `200` response, and then proceed as normal. To use this feature, call `proxy = driver.proxy(url)` where `url` is the origin of the proxy, including a username and password if required. This produces an object that manages the process of connecting via the proxy. You should call `proxy.start` to begin the connection process, and pass data you receive via the socket to `proxy.parse(data)`. When the proxy emits `:connect`, you should then start sending incoming data to `driver.parse(data)` as normal, and call `driver.start`. ```rb proxy = driver.proxy('http://username:password@proxy.example.com') proxy.on :connect, -> (event) do driver.start end ``` The proxy's `:connect` event is also where you should perform a TLS handshake on your TCP stream, if you are connecting to a `wss:` endpoint. In the event that proxy connection fails, `proxy` will emit an `:error`. You can inspect the proxy's response via `proxy.status` and `proxy.headers`. ```rb proxy.on :error, -> (error) do puts error.message puts proxy.status puts proxy.headers.inspect end ``` Before calling `proxy.start` you can set custom headers using `proxy.set_header`: ```rb proxy.set_header('User-Agent', 'ruby') proxy.start ``` ### Driver API Drivers are created using one of the following methods: ```ruby driver = WebSocket::Driver.rack(socket, options) driver = WebSocket::Driver.server(socket, options) driver = WebSocket::Driver.client(socket, options) ``` The `rack` method returns a driver chosen using the socket's `env`. The `server` method returns a driver that will parse an HTTP request and then decide which driver to use for it using the `rack` method. The `client` method always returns a driver for the RFC version of the protocol with masking enabled on outgoing frames. The `options` argument is optional, and is a hash. It may contain the following keys: * `:max_length` - the maximum allowed size of incoming message frames, in bytes. The default value is `2^26 - 1`, or 1 byte short of 64 MiB. * `:protocols` - an array of strings representing acceptable subprotocols for use over the socket. The driver will negotiate one of these to use via the `Sec-WebSocket-Protocol` header if supported by the other peer. All drivers respond to the following API methods, but some of them are no-ops depending on whether the client supports the behaviour. Note that most of these methods are commands: if they produce data that should be sent over the socket, they will give this to you by calling `socket.write(string)`. #### `driver.on :open, -> (event) { }` Adds a callback block to execute when the socket becomes open. #### `driver.on :message, -> (event) { }` Adds a callback block to execute when a message is received. `event` will have a `data` attribute containing either a string in the case of a text message or an array of integers in the case of a binary message. #### `driver.on :error, -> (event) { }` Adds a callback to execute when a protocol error occurs due to the other peer sending an invalid byte sequence. `event` will have a `message` attribute describing the error. #### `driver.on :close, -> (event) { }` Adds a callback block to execute when the socket becomes closed. The `event` object has `code` and `reason` attributes. #### `driver.add_extension(extension)` Registers a protocol extension whose operation will be negotiated via the `Sec-WebSocket-Extensions` header. `extension` is any extension compatible with the [websocket-extensions](https://github.com/faye/websocket-extensions-ruby) framework. #### `driver.set_header(name, value)` Sets a custom header to be sent as part of the handshake response, either from the server or from the client. Must be called before `start`, since this is when the headers are serialized and sent. #### `driver.start` Initiates the protocol by sending the handshake - either the response for a server-side driver or the request for a client-side one. This should be the first method you invoke. Returns `true` if and only if a handshake was sent. #### `driver.parse(string)` Takes a string and parses it, potentially resulting in message events being emitted (see `on('message')` above) or in data being sent to `socket.write`. You should send all data you receive via I/O to this method. #### `driver.text(string)` Sends a text message over the socket. If the socket handshake is not yet complete, the message will be queued until it is. Returns `true` if the message was sent or queued, and `false` if the socket can no longer send messages. #### `driver.binary(array)` Takes an array of byte-sized integers and sends them as a binary message. Will queue and return `true` or `false` the same way as the `text` method. It will also return `false` if the driver does not support binary messages. #### `driver.ping(string = '', &callback)` Sends a ping frame over the socket, queueing it if necessary. `string` and the `callback` block are both optional. If a callback is given, it will be invoked when the socket receives a pong frame whose content matches `string`. Returns `false` if frames can no longer be sent, or if the driver does not support ping/pong. #### `driver.pong(string = '')` Sends a pong frame over the socket, queueing it if necessary. `string` is optional. Returns `false` if frames can no longer be sent, or if the driver does not support ping/pong. You don't need to call this when a ping frame is received; pings are replied to automatically by the driver. This method is for sending unsolicited pongs. #### `driver.close` Initiates the closing handshake if the socket is still open. For drivers with no closing handshake, this will result in the immediate execution of the `on('close')` callback. For drivers with a closing handshake, this sends a closing frame and `emit('close')` will execute when a response is received or a protocol error occurs. #### `driver.version` Returns the WebSocket version in use as a string. Will either be `hixie-75`, `hixie-76` or `hybi-$version`. #### `driver.protocol` Returns a string containing the selected subprotocol, if any was agreed upon using the `Sec-WebSocket-Protocol` mechanism. This value becomes available after `emit('open')` has fired. ## License (The MIT License) Copyright (c) 2010-2015 James Coglan 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. websocket-driver-0.6.3/metadata.yml0000644000175000017500000000704412643000111015671 0ustar aleealee--- !ruby/object:Gem::Specification name: websocket-driver version: !ruby/object:Gem::Version version: 0.6.3 platform: ruby authors: - James Coglan autorequire: bindir: bin cert_chain: [] date: 2015-11-06 00:00:00.000000000 Z dependencies: - !ruby/object:Gem::Dependency name: websocket-extensions requirement: !ruby/object:Gem::Requirement requirements: - - ">=" - !ruby/object:Gem::Version version: 0.1.0 type: :runtime prerelease: false version_requirements: !ruby/object:Gem::Requirement requirements: - - ">=" - !ruby/object:Gem::Version version: 0.1.0 - !ruby/object:Gem::Dependency name: eventmachine 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: permessage_deflate 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: rake-compiler requirement: !ruby/object:Gem::Requirement requirements: - - "~>" - !ruby/object:Gem::Version version: 0.8.0 type: :development prerelease: false version_requirements: !ruby/object:Gem::Requirement requirements: - - "~>" - !ruby/object:Gem::Version version: 0.8.0 - !ruby/object:Gem::Dependency name: rspec 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' description: email: jcoglan@gmail.com executables: [] extensions: - ext/websocket-driver/extconf.rb extra_rdoc_files: - README.md files: - CHANGELOG.md - README.md - examples/tcp_server.rb - ext/websocket-driver/WebsocketMaskService.java - ext/websocket-driver/extconf.rb - ext/websocket-driver/websocket_mask.c - lib/websocket/driver.rb - lib/websocket/driver/client.rb - lib/websocket/driver/draft75.rb - lib/websocket/driver/draft76.rb - lib/websocket/driver/event_emitter.rb - lib/websocket/driver/headers.rb - lib/websocket/driver/hybi.rb - lib/websocket/driver/hybi/frame.rb - lib/websocket/driver/hybi/message.rb - lib/websocket/driver/proxy.rb - lib/websocket/driver/server.rb - lib/websocket/driver/stream_reader.rb - lib/websocket/driver/utf8_match.rb - lib/websocket/http.rb - lib/websocket/http/headers.rb - lib/websocket/http/request.rb - lib/websocket/http/response.rb - lib/websocket/websocket_mask.rb homepage: http://github.com/faye/websocket-driver-ruby licenses: - MIT metadata: {} post_install_message: rdoc_options: - "--main" - README.md - "--markup" - markdown 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.4.5.1 signing_key: specification_version: 4 summary: WebSocket protocol handler with pluggable I/O test_files: []