websocket-driver 0.2.0 → 0.2.1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 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

data/lib/websocket/driver.rb

@@ -78,7 +78,7 @@ module WebSocket
 
     def start
       return false unless @ready_state == 0
-      @socket.write(handshake_response)
+      @socket.write(Driver.encode(handshake_response, :binary))
       open unless @stage == -1
       true
     end
@@ -116,14 +116,6 @@ module WebSocket
       true
     end
 
-    def self.encode(string, validate_encoding = false)
-      if Array === string
-        string = utf8_string(string)
-        return nil if validate_encoding and !valid_utf8?(string)
-      end
-      utf8_string(string)
-    end
-
     def self.client(socket, options = {})
       Client.new(socket, options.merge(:masking => true))
     end
@@ -143,6 +135,23 @@ module WebSocket
       end
     end
 
+    def self.encode(string, encoding = nil)
+      if Array === string
+        string = string.pack('C*')
+        encoding ||= :binary
+      else
+        encoding ||= :utf8
+      end
+      case encoding
+      when :binary
+        string.force_encoding('ASCII-8BIT') if string.respond_to?(:force_encoding)
+      when :utf8
+        string.force_encoding('UTF-8') if string.respond_to?(:force_encoding)
+        return nil unless valid_utf8?(string)
+      end
+      string
+    end
+
     def self.utf8_string(string)
       string = string.pack('C*') if Array === string
       string.respond_to?(:force_encoding) ?
@@ -150,8 +159,7 @@ module WebSocket
           string
     end
 
-    def self.valid_utf8?(byte_array)
-      string = utf8_string(byte_array)
+    def self.valid_utf8?(string)
       if defined?(UTF8_MATCH)
         UTF8_MATCH =~ string ? true : false
       else

data/lib/websocket/driver/client.rb

@@ -23,7 +23,7 @@ module WebSocket
 
       def start
         return false unless @ready_state == -1
-        @socket.write(handshake_request)
+        @socket.write(Driver.encode(handshake_request, :binary))
         @ready_state = 0
         true
       end

data/lib/websocket/driver/draft75.rb

@@ -41,7 +41,7 @@ module WebSocket
 
             when 2 then
               if data == 0xFF
-                emit(:message, MessageEvent.new(Driver.encode(@buffer)))
+                emit(:message, MessageEvent.new(Driver.encode(@buffer, :utf8)))
                 @stage = 0
               else
                 if @length
@@ -57,9 +57,8 @@ module WebSocket
 
       def frame(data, type = nil, error_type = nil)
         return queue([data, type, error_type]) if @ready_state == 0
-        data = Driver.encode(data)
-        frame = ["\x00", data, "\xFF"].map(&Driver.method(:encode)) * ''
-        @socket.write(frame)
+        frame = ["\x00", data, "\xFF"].map { |s| Driver.encode(s, :binary) } * ''
+        @socket.write(Driver.encode(frame, :binary))
         true
       end
 

data/lib/websocket/driver/draft76.rb

@@ -23,7 +23,7 @@ module WebSocket
 
       def close(reason = nil, code = nil)
         return false if @ready_state == 3
-        @socket.write("\xFF\x00")
+        @socket.write(Driver.encode("\xFF\x00", :binary))
         @ready_state = 3
         emit(:close, CloseEvent.new(nil, nil))
         true
@@ -63,7 +63,7 @@ module WebSocket
 
       def send_handshake_body
         return unless signature = handshake_signature
-        @socket.write(signature)
+        @socket.write(Driver.encode(signature, :binary))
         @stage = 0
         open
         parse(@body[BODY_SIZE..-1]) if @body.size > BODY_SIZE

data/lib/websocket/driver/hybi.rb

@@ -103,11 +103,11 @@ module WebSocket
       end
 
       def frame(data, type = nil, code = nil)
-        return queue([data, type, code]) if @ready_state == 0
+        return queue([data, type, code]) if @ready_state <= 0
         return false unless @ready_state == 1
 
         data = data.to_s unless Array === data
-        data = Driver.encode(data) if String === data
+        data = Driver.encode(data, :utf8) if String === data
 
         is_text = (String === data)
         opcode  = OPCODES[type || (is_text ? :text : :binary)]
@@ -151,7 +151,7 @@ module WebSocket
 
         frame.concat(buffer)
 
-        @socket.write(Driver.encode(frame))
+        @socket.write(Driver.encode(frame, :binary))
         true
       end
 
@@ -292,7 +292,7 @@ module WebSocket
             @buffer.concat(payload)
             if @final
               message = @buffer
-              message = Driver.encode(message, true) if @mode == :text
+              message = Driver.encode(message, :utf8) if @mode == :text
               reset
               if message
                 emit(:message, MessageEvent.new(message))
@@ -303,7 +303,7 @@ module WebSocket
 
           when OPCODES[:text] then
             if @final
-              message = Driver.encode(payload, true)
+              message = Driver.encode(payload, :utf8)
               if message
                 emit(:message, MessageEvent.new(message))
               else
@@ -331,18 +331,20 @@ module WebSocket
               code = ERRORS[:protocol_error]
             end
 
-            if payload.size > 125 or not Driver.valid_utf8?(payload[2..-1] || [])
+            message = Driver.encode(payload[2..-1] || [], :utf8)
+
+            if payload.size > 125 or message.nil?
               code = ERRORS[:protocol_error]
             end
 
-            reason = (payload.size > 2) ? Driver.encode(payload[2..-1], true) : ''
+            reason = (payload.size > 2) ? message : ''
             shutdown(code, reason || '')
 
           when OPCODES[:ping] then
             frame(payload, :pong)
 
           when OPCODES[:pong] then
-            message = Driver.encode(payload, true)
+            message = Driver.encode(payload, :utf8)
             callback = @ping_callbacks[message]
             @ping_callbacks.delete(message)
             callback.call if callback

data/lib/websocket/driver/server.rb

@@ -50,7 +50,7 @@ module WebSocket
       end
 
       def write(data)
-        @socket.write(data)
+        @socket.write(Driver.encode(data, :binary))
       end
 
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket-driver
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-12 00:00:00.000000000 Z
+date: 2013-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine