websocket-driver 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bbde50af6076801dfb22819c21ac9faceed294e
-  data.tar.gz: 191ae0db699002539e938eeb04a06cc4f8cf2dd7
+  metadata.gz: 4a069093c87a31c96d30a911bf3855fec2efc384
+  data.tar.gz: ea4afb6bcd928bdd6075e68da402875d9470b2f9
 SHA512:
-  metadata.gz: 4734fc2fbfb2cf6365c33cc8f545908ea5e643b7c85db5beeade7aee3e96222ec3a3d7cb84ae6972ba01edb2e9ebfafdbe2e41820473ba2a448868ebbf506f00
-  data.tar.gz: 9c60a203a6e9681f9496182e07792563b6698e1ea3d19c01201c94c996d1a839fa38425677dfd6ad289bbdde246aaf2d8c5cd72d9ac5ceede37dccd9c845b019
+  metadata.gz: 01272dedc949458909b2b6dc3acab09a12812ac5de1b0e1d44796d8406678de2445cfe11cdc47e52d447022c0ea5f86acae8aa592ed5c2575073f2c065411e1a
+  data.tar.gz: 9bd6c3e39ede403a35a3388b1593a8866e3b3dc851e15f86f1799f9a1abe8887fd4888733c35573faf13dd603487110928fbd91fd0f2de61aac8c43a5dbf8131

data/CHANGELOG.md

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

data/README.md

@@ -274,23 +274,23 @@ 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) { }`
+#### `driver.on :open, -> (event) { }`
 
 Adds a callback block to execute when the socket becomes open.
 
-#### `driver.on 'message', -> (event) { }`
+#### `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) { }`
+#### `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) { }`
+#### `driver.on :close, -> (event) { }`
 
 Adds a callback block to execute when the socket becomes closed. The `event`
 object has `code` and `reason` attributes.

data/lib/websocket/driver/client.rb

@@ -21,10 +21,10 @@ module WebSocket
         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['Host']                  = host
+        @headers['Upgrade']               = 'websocket'
+        @headers['Connection']            = 'Upgrade'
+        @headers['Sec-WebSocket-Key']     = @key
         @headers['Sec-WebSocket-Version'] = '13'
 
         if @protocols.size > 0
@@ -52,11 +52,11 @@ module WebSocket
         true
       end
 
-      def parse(buffer)
+      def parse(chunk)
         return if @ready_state == 3
         return super if @ready_state > 0
 
-        @http.parse(buffer)
+        @http.parse(chunk)
         return fail_handshake('Invalid HTTP response') if @http.error?
         return unless @http.complete?
 

data/lib/websocket/driver/draft75.rb

@@ -6,9 +6,9 @@ module WebSocket
         super
         @stage = 0
 
-        @headers['Upgrade'] = 'WebSocket'
-        @headers['Connection'] = 'Upgrade'
-        @headers['WebSocket-Origin'] = @socket.env['HTTP_ORIGIN']
+        @headers['Upgrade']            = 'WebSocket'
+        @headers['Connection']         = 'Upgrade'
+        @headers['WebSocket-Origin']   = @socket.env['HTTP_ORIGIN']
         @headers['WebSocket-Location'] = @socket.url
       end
 
@@ -23,37 +23,36 @@ module WebSocket
         true
       end
 
-      def parse(buffer)
+      def parse(chunk)
         return if @ready_state > 1
 
-        @reader.put(buffer)
+        @reader.put(chunk)
 
-        @reader.each_byte do |data|
+        @reader.each_byte do |octet|
           case @stage
             when -1 then
-              @body << data
+              @body << octet
               send_handshake_body
 
             when 0 then
-              parse_leading_byte(data)
+              parse_leading_byte(octet)
 
             when 1 then
-              value = (data & 0x7F)
-              @length = value + 128 * @length
+              @length = (octet & 0x7F) + 128 * @length
 
               if @closing and @length.zero?
                 return close
-              elsif (0x80 & data) != 0x80
+              elsif (octet & 0x80) != 0x80
                 if @length.zero?
                   @stage = 0
                 else
                   @skipped = 0
-                  @stage = 2
+                  @stage   = 2
                 end
               end
 
             when 2 then
-              if data == 0xFF
+              if octet == 0xFF
                 @stage = 0
                 emit(:message, MessageEvent.new(Driver.encode(@buffer, :utf8)))
               else
@@ -61,7 +60,7 @@ module WebSocket
                   @skipped += 1
                   @stage = 0 if @skipped == @length
                 else
-                  @buffer << data
+                  @buffer << octet
                   return close if @buffer.size > @max_length
                 end
               end
@@ -69,10 +68,10 @@ module WebSocket
         end
       end
 
-      def frame(data, type = nil, error_type = nil)
-        return queue([data, type, error_type]) if @ready_state == 0
-        frame = ["\x00", data, "\xFF"].map { |s| Driver.encode(s, :binary) } * ''
-        @socket.write(Driver.encode(frame, :binary))
+      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
 
@@ -84,8 +83,8 @@ module WebSocket
         headers.join("\r\n")
       end
 
-      def parse_leading_byte(data)
-        if (0x80 & data) == 0x80
+      def parse_leading_byte(octet)
+        if (octet & 0x80) == 0x80
           @length = 0
           @stage  = 1
         else

data/lib/websocket/driver/draft76.rb

@@ -29,7 +29,7 @@ module WebSocket
 
       def close(reason = nil, code = nil)
         return false if @ready_state == 3
-        @socket.write(Driver.encode("\xFF\x00", :binary))
+        @socket.write([0xFF, 0x00].pack('C*'))
         @ready_state = 3
         emit(:close, CloseEvent.new(nil, nil))
         true
@@ -53,9 +53,7 @@ module WebSocket
         key2   = env['HTTP_SEC_WEBSOCKET_KEY2']
         value2 = number_from_key(key2) / spaces_in_key(key2)
 
-        Digest::MD5.digest(big_endian(value1) +
-                           big_endian(value2) +
-                           head)
+        Digest::MD5.digest([value1, value2, head].pack('N2A*'))
       end
 
       def send_handshake_body
@@ -66,11 +64,11 @@ module WebSocket
         parse(@body[BODY_SIZE..-1]) if @body.bytesize > BODY_SIZE
       end
 
-      def parse_leading_byte(data)
-        return super unless data == 0xFF
+      def parse_leading_byte(octet)
+        return super unless octet == 0xFF
         @closing = true
-        @length = 0
-        @stage = 1
+        @length  = 0
+        @stage   = 1
       end
 
       def number_from_key(key)
@@ -80,14 +78,6 @@ module WebSocket
       def spaces_in_key(key)
         key.scan(/ /).size
       end
-
-      def big_endian(number)
-        string = Driver.encode('', :binary)
-        [24, 16, 8, 0].each do |offset|
-          string << (number >> offset & 0xFF).chr
-        end
-        string
-      end
     end
 
   end

data/lib/websocket/driver/event_emitter.rb

@@ -13,7 +13,11 @@ module WebSocket
       end
 
       def on(event, callable = nil, &block)
-        add_listener(event, callable, &block)
+        if callable
+          add_listener(event, callable)
+        else
+          add_listener(event, &block)
+        end
       end
 
       def remove_listener(event, callable = nil, &block)

data/lib/websocket/driver/headers.rb

@@ -5,7 +5,7 @@ module WebSocket
       ALLOWED_DUPLICATES = %w[set-cookie set-cookie2 warning www-authenticate]
 
       def initialize(received = {})
-        @raw   = received
+        @raw = received
         clear
 
         @received = {}

data/lib/websocket/driver/hybi.rb

@@ -50,6 +50,8 @@ module WebSocket
       MIN_RESERVED_ERROR = 3000
       MAX_RESERVED_ERROR = 4999
 
+      PACK_FORMATS = {2 => 'n', 8 => 'Q>'}
+
       def initialize(socket, options = {})
         super
 
@@ -66,8 +68,8 @@ module WebSocket
         sec_key = @socket.env['HTTP_SEC_WEBSOCKET_KEY']
         protos  = @socket.env['HTTP_SEC_WEBSOCKET_PROTOCOL']
 
-        @headers['Upgrade'] = 'websocket'
-        @headers['Connection'] = 'Upgrade'
+        @headers['Upgrade']              = 'websocket'
+        @headers['Connection']           = 'Upgrade'
         @headers['Sec-WebSocket-Accept'] = Hybi.generate_accept(sec_key)
 
         if protos = @socket.env['HTTP_SEC_WEBSOCKET_PROTOCOL']
@@ -86,8 +88,8 @@ module WebSocket
         true
       end
 
-      def parse(data)
-        @reader.put(data)
+      def parse(chunk)
+        @reader.put(chunk)
         buffer = true
         while buffer
           case @stage
@@ -158,21 +160,19 @@ module WebSocket
         end
       end
 
-      def frame(data, type = nil, code = nil)
-        return queue([data, type, code]) if @ready_state <= 0
+      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 === data
+        is_text = String === buffer
 
         message.rsv1   = message.rsv2 = message.rsv3 = false
         message.opcode = OPCODES[type || (is_text ? :text : :binary)]
 
-        payload = is_text ? data.bytes.to_a : data
-        if code
-          payload = [(code >> 8) & BYTE, code & BYTE, *payload]
-        end
+        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)
@@ -215,18 +215,10 @@ module WebSocket
           buffer[1] = masked | length
         elsif length <= 65535
           buffer[1] = masked | 126
-          buffer[2] = (length >> 8) & BYTE
-          buffer[3] = length & BYTE
+          buffer[2..3] = [length].pack(PACK_FORMATS[2]).bytes.to_a
         else
           buffer[1] = masked | 127
-          buffer[2] = (length >> 56) & BYTE
-          buffer[3] = (length >> 48) & BYTE
-          buffer[4] = (length >> 40) & BYTE
-          buffer[5] = (length >> 32) & BYTE
-          buffer[6] = (length >> 24) & BYTE
-          buffer[7] = (length >> 16) & BYTE
-          buffer[8] = (length >> 8)  & BYTE
-          buffer[9] = length & BYTE
+          buffer[2..9] = [length].pack(PACK_FORMATS[8]).bytes.to_a
         end
 
         if frame.masked
@@ -271,16 +263,16 @@ module WebSocket
         shutdown(ERRORS[type], message, true)
       end
 
-      def parse_opcode(data)
-        rsvs = [RSV1, RSV2, RSV3].map { |rsv| (data & rsv) == rsv }
+      def parse_opcode(octet)
+        rsvs = [RSV1, RSV2, RSV3].map { |rsv| (octet & rsv) == rsv }
 
         @frame = Frame.new
 
-        @frame.final  = (data & FIN) == FIN
+        @frame.final  = (octet & FIN) == FIN
         @frame.rsv1   = rsvs[0]
         @frame.rsv2   = rsvs[1]
         @frame.rsv3   = rsvs[2]
-        @frame.opcode = (data & OPCODE)
+        @frame.opcode = (octet & OPCODE)
 
         @stage = 1
 
@@ -304,9 +296,9 @@ module WebSocket
         end
       end
 
-      def parse_length(data)
-        @frame.masked = (data & MASK) == MASK
-        @frame.length = (data & LENGTH)
+      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
@@ -322,7 +314,7 @@ module WebSocket
       end
 
       def parse_extended_length(buffer)
-        @frame.length = integer(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
@@ -411,14 +403,6 @@ module WebSocket
       rescue ::WebSocket::Extensions::ExtensionError => error
         fail(:extension_error, error.message)
       end
-
-      def integer(buffer)
-        number = 0
-        buffer.each_byte.with_index do |data, i|
-          number += data << (8 * (buffer.bytesize - 1 - i))
-        end
-        number
-      end
     end
 
   end

data/lib/websocket/driver/proxy.rb

@@ -48,11 +48,11 @@ module WebSocket
         true
       end
 
-      def parse(buffer)
-        @http.parse(buffer)
+      def parse(chunk)
+        @http.parse(chunk)
         return unless @http.complete?
 
-        @status = @http.code
+        @status  = @http.code
         @headers = Headers.new(@http.headers)
 
         if @status == 200

data/lib/websocket/driver/server.rb

@@ -39,10 +39,10 @@ module WebSocket
         end
       end
 
-      def parse(buffer)
-        return @delegate.parse(buffer) if @delegate
+      def parse(chunk)
+        return @delegate.parse(chunk) if @delegate
 
-        @http.parse(buffer)
+        @http.parse(chunk)
         return fail_request('Invalid HTTP request') if @http.error?
         return unless @http.complete?
 
@@ -56,8 +56,8 @@ module WebSocket
         emit(:connect, ConnectEvent.new)
       end
 
-      def write(data)
-        @socket.write(Driver.encode(data, :binary))
+      def write(buffer)
+        @socket.write(Driver.encode(buffer, :binary))
       end
 
     private

data/lib/websocket/driver/stream_reader.rb

@@ -10,9 +10,9 @@ module WebSocket
         @offset = 0
       end
 
-      def put(buffer)
-        return unless buffer and buffer.bytesize > 0
-        @buffer << Driver.encode(buffer, :binary)
+      def put(chunk)
+        return unless chunk and chunk.bytesize > 0
+        @buffer << Driver.encode(chunk, :binary)
       end
 
       # Read bytes from the data:
@@ -30,9 +30,9 @@ module WebSocket
       def each_byte
         prune
 
-        @buffer.each_byte do |value|
+        @buffer.each_byte do |octet|
           @offset += 1
-          yield value
+          yield octet
         end
       end
 

data/lib/websocket/http/headers.rb

@@ -51,9 +51,9 @@ module WebSocket
         @stage == -1
       end
 
-      def parse(data)
-        data.each_byte do |byte|
-          if byte == LF and @stage < 2
+      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
@@ -71,7 +71,7 @@ module WebSocket
             end
             @buffer = []
           else
-            @buffer << byte if @stage >= 0
+            @buffer << octet if @stage >= 0
             error if @stage < 2 and @buffer.size > MAX_LINE_LENGTH
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: websocket-driver
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - James Coglan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-08 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-extensions