websocket-driver 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e35545d555e0f2a1d4846483ed021aed831be4aa
-  data.tar.gz: 4fbb5db8194130225cc4130862cec3126729fafe
+  metadata.gz: 4cf0e0cdac07ab4b3dd087f8d74b36613f3e9090
+  data.tar.gz: 3282dd2b2f10817324192f29966b14be4611a8b9
 SHA512:
-  metadata.gz: ddf14ddda68f212cd4453fd0b5e97f8e3b1e0c9741d2bfbb1e6b7b208846cd636b7d73045af9975de3451d7a1c8995e455429e10ea00b3a03026b64d90c44d9f
-  data.tar.gz: dd0fd4513efe1a75012d942293b751de86e1c45836b3551b54e52044df95c0f005ae50ad2a8a761e79f5e3f1f4ec872d97116c7750ffbb3964f4ca327509abeb
+  metadata.gz: b99062bf639a33cf257613632b7f5bf9f08d514c4c7d13de6ee022e62fb749632318c534087b5800b23e958b53389b96d9efb78ca324b3a17089ab13e3817736
+  data.tar.gz: 51dff6847b37deb3e0451dfbbfa220ab93fb149215cae124ef4fb94b52974c891c175bbab537ac3d6cc9c6e851e95fe6db805286639bb72051e6b57ca5cd01ad

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.6.4 / 2016-05-20
+
+* Amend warnings issued when running with -W2
+* Make sure message strings passed in by the app are transcoded to UTF-8
+* Copy strings if necessary for frozen-string compatibility
+
 ### 0.6.3 / 2015-11-06
 
 * Reject draft-76 handshakes if their Sec-WebSocket-Key headers are invalid

data/README.md

@@ -373,7 +373,7 @@ using the `Sec-WebSocket-Protocol` mechanism. This value becomes available after
 
 (The MIT License)
 
-Copyright (c) 2010-2015 James Coglan
+Copyright (c) 2010-2016 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

data/lib/websocket/driver.rb

@@ -33,13 +33,12 @@ module WebSocket
       end
     end
 
-    unless String.instance_methods.include?(:force_encoding)
-      require root + '/utf8_match'
-    end
-
     MAX_LENGTH = 0x3ffffff
     STATES     = [:connecting, :open, :closing, :closed]
 
+    BINARY  = 'ASCII-8BIT'
+    UNICODE = 'UTF-8'
+
     ConnectEvent = Struct.new(nil)
     OpenEvent    = Struct.new(nil)
     MessageEvent = Struct.new(:data)
@@ -94,13 +93,14 @@ module WebSocket
       return false unless @ready_state == 0
       response = handshake_response
       return false unless response
-      @socket.write(Driver.encode(response, :binary))
+      @socket.write(response)
       open unless @stage == -1
       true
     end
 
     def text(message)
-      frame(message)
+      message = message.encode(UNICODE) unless message.encoding.name == UNICODE
+      frame(message, :text)
     end
 
     def binary(message)
@@ -159,14 +159,15 @@ module WebSocket
       case string
         when Array then
           string = string.pack('C*')
-          encoding ||= :binary
+          encoding ||= BINARY
         when String then
-          encoding ||= :utf8
+          encoding ||= UNICODE
+      end
+      unless string.encoding.name == encoding
+        string = string.dup if string.frozen?
+        string.force_encoding(encoding)
       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
+      string.valid_encoding? ? string : nil
     end
 
     def self.validate_options(options, valid_keys)
@@ -177,14 +178,6 @@ module WebSocket
       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']    || ''

data/lib/websocket/driver/client.rb

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

data/lib/websocket/driver/draft75.rb

@@ -4,7 +4,9 @@ module WebSocket
     class Draft75 < Driver
       def initialize(socket, options = {})
         super
-        @stage = 0
+
+        @stage   = 0
+        @closing = false
 
         @headers['Upgrade']            = 'WebSocket'
         @headers['Connection']         = 'Upgrade'
@@ -54,7 +56,7 @@ module WebSocket
             when 2 then
               if octet == 0xFF
                 @stage = 0
-                emit(:message, MessageEvent.new(Driver.encode(@buffer, :utf8)))
+                emit(:message, MessageEvent.new(Driver.encode(@buffer, UNICODE)))
               else
                 if @length
                   @skipped += 1

data/lib/websocket/driver/draft76.rb

@@ -8,7 +8,7 @@ module WebSocket
         super
         input  = @socket.env['rack.input']
         @stage = -1
-        @body  = Driver.encode(input ? input.read : '', :binary)
+        @body  = (input ? input.read : String.new('')).force_encoding(BINARY)
 
         @headers.clear
         @headers['Upgrade'] = 'WebSocket'
@@ -70,7 +70,7 @@ module WebSocket
 
       def send_handshake_body
         return unless signature = handshake_signature
-        @socket.write(Driver.encode(signature, :binary))
+        @socket.write(signature)
         @stage = 0
         open
         parse(@body[BODY_SIZE..-1]) if @body.bytesize > BODY_SIZE

data/lib/websocket/driver/hybi.rb

@@ -64,6 +64,8 @@ module WebSocket
         @require_masking = options[:require_masking]
         @ping_callbacks  = {}
 
+        @frame = @message = nil
+
         return unless @socket.respond_to?(:env)
 
         sec_key = @socket.env['HTTP_SEC_WEBSOCKET_KEY']
@@ -127,10 +129,6 @@ module WebSocket
         end
       end
 
-      def text(message)
-        frame(message, :text)
-      end
-
       def binary(message)
         frame(message, :binary)
       end
@@ -201,8 +199,6 @@ module WebSocket
 
       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
 
@@ -356,7 +352,7 @@ module WebSocket
 
           when OPCODES[:close] then
             code   = (bytesize >= 2) ? payload.unpack(PACK_FORMATS[2]).first : nil
-            reason = (bytesize > 2)  ? Driver.encode(bytes[2..-1] || [], :utf8) : nil
+            reason = (bytesize > 2)  ? Driver.encode(bytes[2..-1] || [], UNICODE) : nil
 
             unless (bytesize == 0) or
                    (code && code >= MIN_RESERVED_ERROR && code <= MAX_RESERVED_ERROR) or
@@ -374,7 +370,7 @@ module WebSocket
             frame(payload, :pong)
 
           when OPCODES[:pong] then
-            message = Driver.encode(payload, :utf8)
+            message = Driver.encode(payload, UNICODE)
             callback = @ping_callbacks[message]
             @ping_callbacks.delete(message)
             callback.call if callback
@@ -391,7 +387,7 @@ module WebSocket
 
         case message.opcode
           when OPCODES[:text] then
-            payload = Driver.encode(payload, :utf8)
+            payload = Driver.encode(payload, UNICODE)
           when OPCODES[:binary]
             payload = payload.bytes.to_a
         end

data/lib/websocket/driver/hybi/message.rb

@@ -14,7 +14,7 @@ module WebSocket
           @rsv2   = false
           @rsv3   = false
           @opcode = nil
-          @data   = Driver.encode('', :binary)
+          @data   = String.new('').force_encoding(BINARY)
         end
 
         def <<(frame)

data/lib/websocket/driver/proxy.rb

@@ -44,7 +44,7 @@ module WebSocket
         start   = "CONNECT #{@origin.host}:#{port} HTTP/1.1"
         headers = [start, @headers.to_s, '']
 
-        @socket.write(Driver.encode(headers.join("\r\n"), :binary))
+        @socket.write(headers.join("\r\n"))
         true
       end
 

data/lib/websocket/driver/server.rb

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

data/lib/websocket/driver/stream_reader.rb

@@ -6,13 +6,13 @@ module WebSocket
       MINIMUM_AUTOMATIC_PRUNE_OFFSET = 128
 
       def initialize
-        @buffer = Driver.encode('', :binary)
+        @buffer = String.new('').force_encoding(BINARY)
         @offset = 0
       end
 
       def put(chunk)
         return unless chunk and chunk.bytesize > 0
-        @buffer << Driver.encode(chunk, :binary)
+        @buffer << chunk.force_encoding(BINARY)
       end
 
       # Read bytes from the data:
@@ -42,7 +42,7 @@ module WebSocket
         buffer_size = @buffer.bytesize
 
         if @offset > buffer_size
-          @buffer = Driver.encode('', :binary)
+          @buffer = String.new('').force_encoding(BINARY)
         else
           @buffer = @buffer.byteslice(@offset, buffer_size - @offset)
         end

data/lib/websocket/http/headers.rb

@@ -39,6 +39,7 @@ module WebSocket
 
       def initialize
         @buffer  = []
+        @env     = {}
         @headers = {}
         @stage   = 0
       end
@@ -75,7 +76,7 @@ module WebSocket
             error if @stage < 2 and @buffer.size > MAX_LINE_LENGTH
           end
         end
-        @env['rack.input'] = StringIO.new(string_buffer) if @env
+        @env['rack.input'] = StringIO.new(string_buffer)
       end
 
     private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: websocket-driver
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - James Coglan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-extensions
@@ -106,7 +106,6 @@ files:
 - 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
@@ -136,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: WebSocket protocol handler with pluggable I/O

data/lib/websocket/driver/utf8_match.rb

@@ -1,6 +0,0 @@
-module 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