websocket 1.2.3 → 1.2.9

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest/md5'
 
 module WebSocket
@@ -6,7 +8,7 @@ module WebSocket
       class Client76 < Client75
         # @see WebSocket::Handshake::Base#valid?
         def valid?
-          super && verify_challenge
+          super && verify_challenge && verify_protocol
         end
 
         private
@@ -62,22 +64,22 @@ module WebSocket
         # Verify if challenge sent by server match generated one
         # @return [Boolena] True if challenge matches, false otherwise(sets appropriate error)
         def verify_challenge
-          fail WebSocket::Error::Handshake::InvalidAuthentication unless @handshake.leftovers == challenge
+          raise WebSocket::Error::Handshake::InvalidAuthentication unless @handshake.leftovers == challenge
           true
         end
 
         NOISE_CHARS = ("\x21".."\x2f").to_a + ("\x3a".."\x7e").to_a
 
         # Generate Sec-WebSocket-Key1 and Sec-WebSocket-Key2
-        # @param [String] name of key. Will be used to set number variable needed later. Valid values: key1, key2
+        # @param key [String] name of key. Will be used to set number variable needed later. Valid values: key1, key2
         # @return [String] generated key
         def generate_key(key)
-          spaces = 1 + rand(12)
+          spaces = rand(1..12)
           max = 0xffffffff / spaces
           number = rand(max + 1)
           instance_variable_set("@#{key}_number", number)
           key = (number * spaces).to_s
-          (1 + rand(12)).times do
+          rand(1..12).times do
             char = NOISE_CHARS[rand(NOISE_CHARS.size)]
             pos = rand(key.size + 1)
             key[pos...pos] = char
@@ -93,6 +95,10 @@ module WebSocket
         def generate_key3
           [rand(0x100000000)].pack('N') + [rand(0x100000000)].pack('N')
         end
+
+        def provided_protocols
+          Array(@handshake.headers['sec-websocket-protocol'].to_s.strip)
+        end
       end
     end
   end

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest/sha1'
 require 'base64'
 
@@ -20,10 +22,10 @@ module WebSocket
         # @see WebSocket::Handshake::Handler::Base#handshake_keys
         def handshake_keys
           [
-            %w(Upgrade websocket),
-            %w(Connection Upgrade),
+            %w[Upgrade websocket],
+            %w[Connection Upgrade],
             ['Sec-WebSocket-Accept', signature]
-          ]
+          ] + protocol
         end
 
         # Signature of response, created from client request Sec-WebSocket-Key
@@ -35,13 +37,19 @@ module WebSocket
         end
 
         def verify_key
-          fail WebSocket::Error::Handshake::InvalidAuthentication unless key
+          raise WebSocket::Error::Handshake::InvalidAuthentication unless key
           true
         end
 
         def key
           @handshake.headers['sec-websocket-key']
         end
+
+        def protocol
+          return [] unless @handshake.headers.key?('sec-websocket-protocol')
+          protos = @handshake.headers['sec-websocket-protocol'].split(/ *, */) & @handshake.protocols
+          [['Sec-WebSocket-Protocol', protos.first]]
+        end
       end
     end
   end

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

@@ -1,9 +1,19 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Handshake
     module Handler
       class Server75 < Server
         private
 
+        def headers
+          {
+            origin: 'WebSocket-Origin',
+            location: 'WebSocket-Location',
+            protocol: 'WebSocket-Protocol'
+          }.freeze
+        end
+
         # @see WebSocket::Handshake::Handler::Base#header_line
         def header_line
           'HTTP/1.1 101 Web Socket Protocol Handshake'
@@ -12,11 +22,17 @@ module WebSocket
         # @see WebSocket::Handshake::Handler::Base#handshake_keys
         def handshake_keys
           [
-            %w(Upgrade WebSocket),
-            %w(Connection Upgrade),
-            ['WebSocket-Origin', @handshake.headers['origin']],
-            ['WebSocket-Location', @handshake.uri]
-          ]
+            %w[Upgrade WebSocket],
+            %w[Connection Upgrade],
+            [headers[:origin], @handshake.headers['origin']],
+            [headers[:location], @handshake.uri]
+          ] + protocol
+        end
+
+        def protocol
+          return [] unless @handshake.headers.key?(headers[:protocol].downcase)
+          proto = @handshake.headers[headers[:protocol].downcase]
+          [[headers[:protocol], @handshake.protocols.include?(proto) ? proto : nil]]
         end
       end
     end

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'digest/md5'
 
 module WebSocket
   module Handshake
     module Handler
-      class Server76 < Server
+      class Server76 < Server75
         # @see WebSocket::Handshake::Base#valid?
         def valid?
           super && !finishing_line.nil?
@@ -11,6 +13,14 @@ module WebSocket
 
         private
 
+        def headers
+          {
+            origin: 'Sec-WebSocket-Origin',
+            location: 'Sec-WebSocket-Location',
+            protocol: 'Sec-WebSocket-Protocol'
+          }.freeze
+        end
+
         # @see WebSocket::Handshake::Base#reserved_leftover_lines
         def reserved_leftover_lines
           1
@@ -21,23 +31,11 @@ module WebSocket
           'HTTP/1.1 101 WebSocket Protocol Handshake'
         end
 
-        # @see WebSocket::Handshake::Handler::Base#handshake_keys
-        def handshake_keys
-          [
-            %w(Upgrade WebSocket),
-            %w(Connection Upgrade),
-            ['Sec-WebSocket-Origin', @handshake.headers['origin']],
-            ['Sec-WebSocket-Location', @handshake.uri]
-          ]
-        end
-
         # @see WebSocket::Handshake::Handler::Base#finishing_line
         def finishing_line
           @finishing_line ||= challenge_response
         end
 
-        private
-
         # Response to client challenge from request Sec-WebSocket-Key1, Sec-WebSocket-Key2 and leftovers
         # @return [String] Challenge response or nil if error occured
         def challenge_response
@@ -60,14 +58,14 @@ module WebSocket
 
           spaces = string.scan(/ /).size
           # As per 5.2.5, abort the connection if spaces are zero.
-          fail WebSocket::Error::Handshake::InvalidAuthentication if spaces == 0
+          raise WebSocket::Error::Handshake::InvalidAuthentication if spaces.zero?
 
           # As per 5.2.6, abort if numbers is not an integral multiple of spaces
-          fail WebSocket::Error::Handshake::InvalidAuthentication if numbers % spaces != 0
+          raise WebSocket::Error::Handshake::InvalidAuthentication if numbers % spaces != 0
 
           quotient = numbers / spaces
 
-          fail WebSocket::Error::Handshake::InvalidAuthentication if quotient > 2**32 - 1
+          raise WebSocket::Error::Handshake::InvalidAuthentication if quotient > 2**32 - 1
 
           quotient
         end

data/lib/websocket/handshake/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Handshake
     # Construct or parse a server WebSocket handshake.
@@ -35,6 +37,7 @@ module WebSocket
       # @param [Hash] args Arguments for server
       #
       # @option args [Boolean] :secure If true then server will use wss:// protocol
+      # @option args [Array<String>] :protocols an array of supported sub-protocols
       #
       # @example
       #   Websocket::Handshake::Server.new(secure: true)
@@ -70,7 +73,7 @@ module WebSocket
       # @example
       #   @handshake.from_rack(env)
       def from_rack(env)
-        @headers = env.select { |key, _value| key =~ /\AHTTP_/ }.each_with_object({}) do |tuple, memo|
+        @headers = env.select { |key, _value| key.to_s.start_with? 'HTTP_' }.each_with_object({}) do |tuple, memo|
           key, value = tuple
           memo[key.gsub(/\AHTTP_/, '').tr('_', '-').downcase] = value
         end
@@ -153,7 +156,7 @@ module WebSocket
                    when 75 then Handler::Server75.new(self)
                    when 76, 0..3 then Handler::Server76.new(self)
                    when 4..17 then Handler::Server04.new(self)
-                   else fail WebSocket::Error::Handshake::UnknownVersion
+                   else raise WebSocket::Error::Handshake::UnknownVersion
                    end
       end
 
@@ -164,9 +167,9 @@ module WebSocket
       # @return [Boolean] True if parsed correctly. False otherwise
       def parse_first_line(line)
         line_parts = line.match(PATH)
-        fail WebSocket::Error::Handshake::InvalidHeader unless line_parts
+        raise WebSocket::Error::Handshake::InvalidHeader unless line_parts
         method = line_parts[1].strip
-        fail WebSocket::Error::Handshake::GetRequestRequired unless method == 'GET'
+        raise WebSocket::Error::Handshake::GetRequestRequired unless method == 'GET'
 
         resource_name = line_parts[2].strip
         @path, @query = resource_name.split('?', 2)

data/lib/websocket/nice_inspect.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module WebSocket
+  module NiceInspect
+    # Recreate inspect as #to_s will be 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
+  end
+end

data/lib/websocket/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
-  VERSION = '1.2.3'
+  VERSION = '1.2.9'.freeze
 end

data/spec/frame/incoming_03_spec.rb

@@ -1,23 +1,26 @@
 # encoding: binary
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Incoming frame draft 03' do
+  subject { frame }
+
   let(:version) { 3 }
   let(:frame) { WebSocket::Frame::Incoming.new(version: version, data: encoded_text) }
   let(:encoded_text) { nil }
   let(:decoded_text) { nil }
   let(:frame_type) { nil }
   let(:error) { nil }
-  subject { frame }
 
-  it_should_behave_like 'valid_incoming_frame'
+  it_behaves_like 'valid_incoming_frame'
 
   context 'should properly decode close frame' do
     let(:encoded_text) { "\x01\x05" + decoded_text }
     let(:frame_type) { :close }
     let(:decoded_text) { 'Hello' }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode ping frame' do
@@ -25,7 +28,7 @@ RSpec.describe 'Incoming frame draft 03' do
     let(:frame_type) { :ping }
     let(:decoded_text) { 'Hello' }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode pong frame' do
@@ -33,7 +36,7 @@ RSpec.describe 'Incoming frame draft 03' do
     let(:frame_type) { :pong }
     let(:decoded_text) { 'Hello' }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode text frame' do
@@ -41,7 +44,7 @@ RSpec.describe 'Incoming frame draft 03' do
     let(:decoded_text) { 'Hello' }
     let(:frame_type) { :text }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode text frame with continuation' do
@@ -49,15 +52,15 @@ RSpec.describe 'Incoming frame draft 03' do
     let(:frame_type)   { :text }
     let(:decoded_text) { 'Hello' }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode text frame in between of continuation' do
     let(:encoded_text) { "\x84\x03Hel\x03\x03abc\x00\x02lo" }
-    let(:frame_type)   { [:pong, :text] }
-    let(:decoded_text) { %w(abc Hello) }
+    let(:frame_type)   { %i[pong text] }
+    let(:decoded_text) { %w[abc Hello] }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should not return unfinished more frame' do
@@ -65,7 +68,7 @@ RSpec.describe 'Incoming frame draft 03' do
     let(:frame_type)   { :pong }
     let(:decoded_text) { 'abc' }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode 256 bytes binary frame' do
@@ -73,7 +76,7 @@ RSpec.describe 'Incoming frame draft 03' do
     let(:frame_type) { :binary }
     let(:decoded_text) { 'a' * 256 }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode 64KiB binary frame' do
@@ -81,14 +84,14 @@ RSpec.describe 'Incoming frame draft 03' do
     let(:frame_type) { :binary }
     let(:decoded_text) { 'a' * 65_536 }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should wait with incomplete frame' do
     let(:encoded_text) { "\x04\x06Hello" }
     let(:decoded_text) { nil }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should raise error with invalid opcode' do
@@ -96,7 +99,7 @@ RSpec.describe 'Incoming frame draft 03' do
     let(:decoded_text) { nil }
     let(:error) { WebSocket::Error::Frame::UnknownOpcode }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should raise error with too long frame' do
@@ -104,7 +107,7 @@ RSpec.describe 'Incoming frame draft 03' do
     let(:decoded_text) { nil }
     let(:error) { WebSocket::Error::Frame::TooLong }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should raise error with continuation frame without more frame earlier' do
@@ -112,6 +115,6 @@ RSpec.describe 'Incoming frame draft 03' do
     let(:decoded_text) { nil }
     let(:error) { WebSocket::Error::Frame::UnexpectedContinuationFrame }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 end

data/spec/frame/incoming_04_spec.rb

@@ -1,23 +1,26 @@
 # encoding: binary
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Incoming frame draft 04' do
+  subject { frame }
+
   let(:version) { 4 }
   let(:frame) { WebSocket::Frame::Incoming.new(version: version, data: encoded_text) }
   let(:encoded_text) { nil }
   let(:decoded_text) { nil }
   let(:frame_type) { nil }
   let(:error) { nil }
-  subject { frame }
 
-  it_should_behave_like 'valid_incoming_frame'
+  it_behaves_like 'valid_incoming_frame'
 
   context 'should properly decode close frame' do
     let(:encoded_text) { "\x81\x05" + decoded_text }
     let(:frame_type) { :close }
     let(:decoded_text) { 'Hello' }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode ping frame' do
@@ -25,7 +28,7 @@ RSpec.describe 'Incoming frame draft 04' do
     let(:frame_type) { :ping }
     let(:decoded_text) { 'Hello' }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode pong frame' do
@@ -33,7 +36,7 @@ RSpec.describe 'Incoming frame draft 04' do
     let(:frame_type) { :pong }
     let(:decoded_text) { 'Hello' }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode text frame' do
@@ -41,7 +44,7 @@ RSpec.describe 'Incoming frame draft 04' do
     let(:decoded_text) { 'Hello' }
     let(:frame_type) { :text }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode text frame with continuation' do
@@ -49,15 +52,15 @@ RSpec.describe 'Incoming frame draft 04' do
     let(:frame_type)   { :text }
     let(:decoded_text) { 'Hello' }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode text frame in between of continuation' do
     let(:encoded_text) { "\x04\x03Hel\x83\x03abc\x80\x02lo" }
-    let(:frame_type)   { [:pong, :text] }
-    let(:decoded_text) { %w(abc Hello) }
+    let(:frame_type)   { %i[pong text] }
+    let(:decoded_text) { %w[abc Hello] }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should not return unfinished more frame' do
@@ -65,7 +68,7 @@ RSpec.describe 'Incoming frame draft 04' do
     let(:frame_type)   { :pong }
     let(:decoded_text) { 'abc' }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode 256 bytes binary frame' do
@@ -73,7 +76,7 @@ RSpec.describe 'Incoming frame draft 04' do
     let(:frame_type) { :binary }
     let(:decoded_text) { 'a' * 256 }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should properly decode 64KiB binary frame' do
@@ -81,14 +84,14 @@ RSpec.describe 'Incoming frame draft 04' do
     let(:frame_type) { :binary }
     let(:decoded_text) { 'a' * 65_536 }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should wait with incomplete frame' do
     let(:encoded_text) { "\x84\x06Hello" }
     let(:decoded_text) { nil }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should raise error with invalid opcode' do
@@ -96,7 +99,7 @@ RSpec.describe 'Incoming frame draft 04' do
     let(:decoded_text) { nil }
     let(:error) { WebSocket::Error::Frame::UnknownOpcode }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should raise error with too long frame' do
@@ -104,7 +107,7 @@ RSpec.describe 'Incoming frame draft 04' do
     let(:decoded_text) { nil }
     let(:error) { WebSocket::Error::Frame::TooLong }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 
   context 'should raise error with continuation frame without more frame earlier' do
@@ -112,6 +115,6 @@ RSpec.describe 'Incoming frame draft 04' do
     let(:decoded_text) { nil }
     let(:error) { WebSocket::Error::Frame::UnexpectedContinuationFrame }
 
-    it_should_behave_like 'valid_incoming_frame'
+    it_behaves_like 'valid_incoming_frame'
   end
 end