websocket 1.2.3 → 1.2.9

data/lib/websocket/frame/handler/handler04.rb

@@ -1,4 +1,5 @@
 # encoding: binary
+# frozen_string_literal: true
 
 module WebSocket
   module Frame

data/lib/websocket/frame/handler/handler05.rb

@@ -1,4 +1,5 @@
 # encoding: binary
+# frozen_string_literal: true
 
 module WebSocket
   module Frame

data/lib/websocket/frame/handler/handler07.rb

@@ -1,4 +1,5 @@
 # encoding: binary
+# frozen_string_literal: true
 
 module WebSocket
   module Frame
@@ -12,15 +13,15 @@ module WebSocket
           close: 8,
           ping: 9,
           pong: 10
-        }
+        }.freeze
 
         # Hash of frame opcodes and it's names
-        FRAME_TYPES_INVERSE = FRAME_TYPES.invert
+        FRAME_TYPES_INVERSE = FRAME_TYPES.invert.freeze
 
         def encode_frame
           if @frame.type == :close
             code = @frame.code || 1000
-            fail WebSocket::Error::Frame::UnknownCloseCode unless valid_code?(code)
+            raise WebSocket::Error::Frame::UnknownCloseCode unless valid_code?(code)
             @frame.data = Data.new([code].pack('n') + @frame.data.to_s)
             @frame.code = nil
           end
@@ -32,8 +33,8 @@ module WebSocket
           if close_code?(result)
             code = result.data.slice!(0..1)
             result.code = code.unpack('n').first
-            fail WebSocket::Error::Frame::UnknownCloseCode unless valid_code?(result.code)
-            fail WebSocket::Error::Frame::InvalidPayloadEncoding unless valid_encoding?(result.data)
+            raise WebSocket::Error::Frame::UnknownCloseCode unless valid_code?(result.code)
+            raise WebSocket::Error::Frame::InvalidPayloadEncoding unless valid_encoding?(result.data)
           end
           result
         end
@@ -41,14 +42,14 @@ module WebSocket
         private
 
         def valid_code?(code)
-          [1000, 1001, 1002, 1003, 1007, 1008, 1009, 1010, 1011].include?(code) || (3000..4999).include?(code)
+          [1000, 1001, 1002, 1003, 1007, 1008, 1009, 1010, 1011].include?(code) || (3000..4999).cover?(code)
         end
 
         def valid_encoding?(data)
           return true if data.nil?
           data.encode('UTF-8')
           true
-        rescue
+        rescue StandardError
           false
         end
 
@@ -61,7 +62,7 @@ module WebSocket
         # @return [Integer] opcode or nil
         # @raise [WebSocket::Error] if frame opcode is not known
         def type_to_opcode(frame_type)
-          FRAME_TYPES[frame_type] || fail(WebSocket::Error::Frame::UnknownFrameType)
+          FRAME_TYPES[frame_type] || raise(WebSocket::Error::Frame::UnknownFrameType)
         end
 
         # Convert frame opcode to type name
@@ -69,7 +70,7 @@ module WebSocket
         # @return [Symbol] Frame type name or nil
         # @raise [WebSocket::Error] if frame type name is not known
         def opcode_to_type(opcode)
-          FRAME_TYPES_INVERSE[opcode] || fail(WebSocket::Error::Frame::UnknownOpcode)
+          FRAME_TYPES_INVERSE[opcode] || raise(WebSocket::Error::Frame::UnknownOpcode)
         end
       end
     end

data/lib/websocket/frame/handler/handler75.rb

@@ -1,4 +1,5 @@
 # encoding: binary
+# frozen_string_literal: true
 
 module WebSocket
   module Frame
@@ -6,7 +7,7 @@ module WebSocket
       class Handler75 < Base
         # @see WebSocket::Frame::Base#supported_frames
         def supported_frames
-          [:text, :close]
+          %i[text close]
         end
 
         # @see WebSocket::Frame::Handler::Base#encode_frame
@@ -17,13 +18,13 @@ module WebSocket
             ary = ["\x00", @frame.data, "\xff"]
             ary.map { |s| s.encode('UTF-8', 'UTF-8', invalid: :replace) }
             ary.join
-          else fail WebSocket::Error::Frame::UnknownFrameType
+          else raise WebSocket::Error::Frame::UnknownFrameType
           end
         end
 
         # @see WebSocket::Frame::Handler::Base#decode_frame
         def decode_frame
-          return if @frame.data.size == 0
+          return if @frame.data.size.zero?
 
           pointer = 0
           frame_type = @frame.data.getbyte(pointer)
@@ -42,7 +43,7 @@ module WebSocket
               break unless (b & 0x80) == 0x80
             end
 
-            fail WebSocket::Error::Frame::TooLong if length > ::WebSocket.max_frame_size
+            raise WebSocket::Error::Frame::TooLong if length > ::WebSocket.max_frame_size
 
             unless @frame.data.getbyte(pointer + length - 1).nil?
               # Straight from spec - I'm sure this isn't crazy...
@@ -51,17 +52,17 @@ module WebSocket
               @frame.instance_variable_set '@data', @frame.data[(pointer + length)..-1]
 
               # If the /frame type/ is 0xFF and the /length/ was 0, then close
-              if length == 0
+              if length.zero?
                 @frame.class.new(version: @frame.version, type: :close, decoded: true)
               end
             end
           else
             # If the high-order bit of the /frame type/ byte is _not_ set
 
-            fail WebSocket::Error::Frame::Invalid if @frame.data.getbyte(0) != 0x00
+            raise WebSocket::Error::Frame::Invalid if @frame.data.getbyte(0) != 0x00
 
             # Addition to the spec to protect against malicious requests
-            fail WebSocket::Error::Frame::TooLong if @frame.data.size > ::WebSocket.max_frame_size
+            raise WebSocket::Error::Frame::TooLong if @frame.data.size > ::WebSocket.max_frame_size
 
             msg = @frame.data.slice!(/\A\x00[^\xff]*\xff/)
             if msg

data/lib/websocket/frame/incoming.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Frame
     # Construct or parse incoming WebSocket Frame.

data/lib/websocket/frame/incoming/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Frame
     class Incoming

data/lib/websocket/frame/incoming/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Frame
     class Incoming

data/lib/websocket/frame/outgoing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Frame
     # Construct or parse incoming WebSocket Frame.
@@ -24,7 +26,7 @@ module WebSocket
 
       # Return raw frame formatted for sending.
       def to_s
-        fail WebSocket::Error::Frame::UnknownFrameType unless supported?
+        raise WebSocket::Error::Frame::UnknownFrameType unless supported?
         @handler.encode_frame
       end
       rescue_method :to_s

data/lib/websocket/frame/outgoing/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Frame
     class Outgoing

data/lib/websocket/frame/outgoing/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Frame
     class Outgoing

data/lib/websocket/handshake.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Handshake
     autoload :Base,    "#{::WebSocket::ROOT}/websocket/handshake/base"

data/lib/websocket/handshake/base.rb

@@ -1,21 +1,33 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Handshake
     # @abstract Subclass and override to implement custom handshakes
     class Base
       include ExceptionHandler
+      include NiceInspect
 
       attr_reader :host, :port, :path, :query,
-                  :state, :version, :secure, :headers
+                  :state, :version, :secure,
+                  :headers, :protocols
 
       # Initialize new WebSocket Handshake and set it's state to :new
       def initialize(args = {})
-        args.each { |k, v| instance_variable_set("@#{k}", v) }
+        args.each do |k, v|
+          value = begin
+            v.dup
+          rescue TypeError
+            v
+          end
+          instance_variable_set("@#{k}", value)
+        end
 
         @state = :new
         @handler = nil
 
-        @data = ''
+        @data = String.new('')
         @headers ||= {}
+        @protocols ||= []
       end
 
       # @abstract Add data to handshake
@@ -30,13 +42,6 @@ module WebSocket
       end
       rescue_method :to_s, return: ''
 
-      # Recreate inspect as #to_s was overwritten
-      def inspect
-        vars = instance_variables.map { |v| "#{v}=#{instance_variable_get(v).inspect}" }.join(', ')
-        insp = Kernel.format("#{self.class}:0x%08x", __id__)
-        "<#{insp} #{vars}>"
-      end
-
       # Is parsing of data finished?
       # @return [Boolena] True if request was completely parsed or error occured. False otherwise
       def finished?
@@ -52,7 +57,7 @@ module WebSocket
 
       # @abstract Should send data after parsing is finished?
       def should_respond?
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       # Data left from parsing. Sometimes data that doesn't belong to handshake are added - use this method to retrieve them.
@@ -66,7 +71,7 @@ module WebSocket
       # @example
       #   @handshake.uri #=> "ws://example.com/path?query=true"
       def uri
-        uri =  secure ? 'wss://' : 'ws://'
+        uri =  String.new(secure ? 'wss://' : 'ws://')
         uri << host
         uri << ":#{port}" if port
         uri << path
@@ -104,7 +109,15 @@ module WebSocket
 
         lines.each do |line|
           h = HEADER.match(line)
-          @headers[h[1].strip.downcase] = h[2].strip if h
+          next unless h # Skip any invalid headers
+          key = h[1].strip.downcase
+          val = h[2].strip
+          # If the header is already set and refers to the websocket protocol, append the new value
+          if @headers.key?(key) && key =~ /^(sec-)?websocket-protocol$/
+            @headers[key] << ", #{val}"
+          else
+            @headers[key] = val
+          end
         end
 
         @state = :finished

data/lib/websocket/handshake/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 module WebSocket
@@ -38,16 +40,17 @@ module WebSocket
       #
       # @param [Hash] args Arguments for client
       #
-      # @option args [String]  :host Host of request. Required if no :url param was provided.
-      # @option args [String]  :origin Origin of request. Optional, should be used mostly by browsers. Default: nil
-      # @option args [String]  :path Path of request. Should start with '/'. Default: '/'
-      # @option args [Integer] :port Port of request. Default: nil
-      # @option args [String]  :query. Query for request. Should be in format "aaa=bbb&ccc=ddd"
-      # @option args [Boolean] :secure Defines protocol to use. If true then wss://, otherwise ws://. This option will not change default port - it should be handled by programmer.
-      # @option args [String]  :url URL of request. Must by in format like ws://example.com/path?query=true. Every part of this url will be overriden by more specific arguments.
-      # @option args [String]  :uri Alias to :url
-      # @option args [Integer] :version Version of WebSocket to use. Default: 13 (this is version from RFC)
-      # @option args [Hash]    :headers HTTP headers to use in the handshake
+      # @option args [String]         :host Host of request. Required if no :url param was provided.
+      # @option args [String]         :origin Origin of request. Optional, should be used mostly by browsers. Default: nil
+      # @option args [String]         :path Path of request. Should start with '/'. Default: '/'
+      # @option args [Integer]        :port Port of request. Default: nil
+      # @option args [String]         :query. Query for request. Should be in format "aaa=bbb&ccc=ddd"
+      # @option args [Boolean]        :secure Defines protocol to use. If true then wss://, otherwise ws://. This option will not change default port - it should be handled by programmer.
+      # @option args [String]         :url URL of request. Must by in format like ws://example.com/path?query=true. Every part of this url will be overriden by more specific arguments.
+      # @option args [String]         :uri Alias to :url
+      # @option args [Array<String>]  :protocols An array of supported sub-protocols
+      # @option args [Integer]        :version Version of WebSocket to use. Default: 13 (this is version from RFC)
+      # @option args [Hash]           :headers HTTP headers to use in the handshake
       #
       # @example
       #   Websocket::Handshake::Client.new(url: "ws://example.com/path?query=true")
@@ -66,7 +69,7 @@ module WebSocket
         @path = '/' if @path.nil? || @path.empty?
         @version ||= DEFAULT_VERSION
 
-        fail WebSocket::Error::Handshake::NoHostProvided unless @host
+        raise WebSocket::Error::Handshake::NoHostProvided unless @host
 
         include_version
       end
@@ -107,7 +110,7 @@ module WebSocket
                    when 1..3  then Handler::Client01.new(self)
                    when 4..10 then Handler::Client04.new(self)
                    when 11..17 then Handler::Client11.new(self)
-                   else fail WebSocket::Error::Handshake::UnknownVersion
+                   else raise WebSocket::Error::Handshake::UnknownVersion
                    end
       end
 
@@ -118,9 +121,9 @@ module WebSocket
       # @return [Boolean] True if parsed correctly. False otherwise
       def parse_first_line(line)
         line_parts = line.match(FIRST_LINE)
-        fail WebSocket::Error::Handshake::InvalidHeader unless line_parts
+        raise WebSocket::Error::Handshake::InvalidHeader unless line_parts
         status = line_parts[1]
-        fail WebSocket::Error::Handshake::InvalidStatusCode unless status == '101'
+        raise WebSocket::Error::Handshake::InvalidStatusCode unless status == '101'
       end
     end
   end

data/lib/websocket/handshake/handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Handshake
     module Handler

data/lib/websocket/handshake/handler/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Handshake
     module Handler

data/lib/websocket/handshake/handler/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Handshake
     module Handler
@@ -15,6 +17,15 @@ module WebSocket
         def handshake_keys
           super + @handshake.headers.to_a
         end
+
+        # Verify if received header matches with one of the sent ones
+        # @return [Boolean] True if matching. False otherwise(appropriate error is set)
+        def verify_protocol
+          return true if supported_protocols.empty?
+          protos = provided_protocols & supported_protocols
+          raise WebSocket::Error::Handshake::UnsupportedProtocol if protos.empty?
+          true
+        end
       end
     end
   end

data/lib/websocket/handshake/handler/client01.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest/md5'
 
 module WebSocket

data/lib/websocket/handshake/handler/client04.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest/sha1'
 require 'base64'
 
@@ -7,7 +9,7 @@ module WebSocket
       class Client04 < Client
         # @see WebSocket::Handshake::Base#valid?
         def valid?
-          super && verify_accept
+          super && verify_accept && verify_protocol
         end
 
         private
@@ -15,8 +17,8 @@ module WebSocket
         # @see WebSocket::Handshake::Handler::Base#handshake_keys
         def handshake_keys
           keys = [
-            %w(Upgrade websocket),
-            %w(Connection Upgrade)
+            %w[Upgrade websocket],
+            %w[Connection Upgrade]
           ]
           host = @handshake.host
           host += ":#{@handshake.port}" if @handshake.port
@@ -25,6 +27,7 @@ module WebSocket
           keys << ['Sec-WebSocket-Origin', @handshake.origin] if @handshake.origin
           keys << ['Sec-WebSocket-Version', @handshake.version]
           keys << ['Sec-WebSocket-Key', key]
+          keys << ['Sec-WebSocket-Protocol', @handshake.protocols.join(', ')] if @handshake.protocols.any?
           keys
         end
 
@@ -43,9 +46,17 @@ module WebSocket
         # Verify if received header Sec-WebSocket-Accept matches generated one.
         # @return [Boolean] True if accept is matching. False otherwise(appropriate error is set)
         def verify_accept
-          fail WebSocket::Error::Handshake::InvalidAuthentication unless @handshake.headers['sec-websocket-accept'] == accept
+          raise WebSocket::Error::Handshake::InvalidAuthentication unless @handshake.headers['sec-websocket-accept'] == accept
           true
         end
+
+        def supported_protocols
+          @handshake.protocols
+        end
+
+        def provided_protocols
+          @handshake.headers['sec-websocket-protocol'].to_s.split(/ *, */)
+        end
       end
     end
   end

data/lib/websocket/handshake/handler/client11.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Handshake
     module Handler

data/lib/websocket/handshake/handler/client75.rb

@@ -1,22 +1,38 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Handshake
     module Handler
       class Client75 < Client
+        # @see WebSocket::Handshake::Base#valid?
+        def valid?
+          super && verify_protocol
+        end
+
         private
 
         # @see WebSocket::Handshake::Handler::Base#handshake_keys
         def handshake_keys
           keys = [
-            %w(Upgrade WebSocket),
-            %w(Connection Upgrade)
+            %w[Upgrade WebSocket],
+            %w[Connection Upgrade]
           ]
           host = @handshake.host
           host += ":#{@handshake.port}" if @handshake.port
           keys << ['Host', host]
           keys << ['Origin', @handshake.origin] if @handshake.origin
+          keys << ['WebSocket-Protocol', @handshake.protocols.first] if @handshake.protocols.any?
           keys += super
           keys
         end
+
+        def supported_protocols
+          Array(@handshake.protocols.first)
+        end
+
+        def provided_protocols
+          Array(@handshake.headers['websocket-protocol'].to_s.strip)
+        end
       end
     end
   end