websocket 1.2.3 → 1.2.9

data/spec/handshake/client_76_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Client draft 76 handshake' do
@@ -7,14 +9,39 @@ RSpec.describe 'Client draft 76 handshake' do
   let(:client_request) { client_handshake_76({ key1: handshake.handler.send(:key1), key2: handshake.handler.send(:key2), key3: handshake.handler.send(:key3) }.merge(@request_params || {})) }
   let(:server_response) { server_handshake_76({ challenge: handshake.handler.send(:challenge) }.merge(@request_params || {})) }
 
-  it_should_behave_like 'all client drafts'
+  it_behaves_like 'all client drafts'
 
-  it 'should disallow client with invalid challenge' do
+  it 'disallows client with invalid challenge' do
     @request_params = { challenge: 'invalid' }
     handshake << server_response
 
     expect(handshake).to be_finished
     expect(handshake).not_to be_valid
-    expect(handshake.error).to eql(:invalid_handshake_authentication)
+    expect(handshake.error).to be(:invalid_handshake_authentication)
+  end
+
+  context 'protocol header specified' do
+    let(:handshake) { WebSocket::Handshake::Client.new(uri: 'ws://example.com/demo', origin: 'http://example.com', version: version, protocols: %w[binary]) }
+
+    context 'supported' do
+      it 'returns a valid handshake' do
+        @request_params = { headers: { 'Sec-WebSocket-Protocol' => 'binary' } }
+        handshake << server_response
+
+        expect(handshake).to be_finished
+        expect(handshake).to be_valid
+      end
+    end
+
+    context 'unsupported' do
+      it 'fails with an unsupported protocol error' do
+        @request_params = { headers: { 'Sec-WebSocket-Protocol' => 'xmpp' } }
+        handshake << server_response
+
+        expect(handshake).to be_finished
+        expect(handshake).not_to be_valid
+        expect(handshake.error).to be(:unsupported_protocol)
+      end
+    end
   end
 end

data/spec/handshake/server_04_spec.rb

@@ -1,18 +1,51 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Server draft 04 handshake' do
   let(:handshake) { WebSocket::Handshake::Server.new }
-  let(:version) { 04 }
+  let(:version) { 4 }
   let(:client_request) { client_handshake_04(@request_params || {}) }
   let(:server_response) { server_handshake_04(@request_params || {}) }
 
-  it_should_behave_like 'all server drafts'
+  it_behaves_like 'all server drafts'
 
-  it 'should disallow request without Sec-WebSocket-Key' do
+  it 'disallows request without Sec-WebSocket-Key' do
     handshake << client_request.gsub(/^Sec-WebSocket-Key:.*\n/, '')
 
     expect(handshake).to be_finished
     expect(handshake).not_to be_valid
-    expect(handshake.error).to eql(:invalid_handshake_authentication)
+    expect(handshake.error).to be(:invalid_handshake_authentication)
+  end
+
+  context 'protocol header specified' do
+    let(:handshake) { WebSocket::Handshake::Server.new(protocols: %w[binary xmpp]) }
+
+    context 'single protocol requested' do
+      it 'returns with the same protocol' do
+        @request_params = { headers: { 'Sec-WebSocket-Protocol' => 'binary' } }
+        handshake << client_request
+
+        expect(handshake.to_s).to match('Sec-WebSocket-Protocol: binary')
+      end
+    end
+
+    context 'multiple protocols requested' do
+      it 'returns with the first supported protocol' do
+        @request_params = { headers: { 'Sec-WebSocket-Protocol' => 'xmpp, binary' } }
+        handshake << client_request
+
+        expect(handshake.to_s).to match('Sec-WebSocket-Protocol: xmpp')
+      end
+    end
+
+    context 'unsupported protocol requested' do
+      it 'reutrns with an empty protocol header' do
+        @request_params = { headers: { 'Sec-WebSocket-Protocol' => 'generic' } }
+        handshake << client_request
+
+        expect(handshake.to_s).to match("Sec-WebSocket-Protocol: \r\n")
+      end
+    end
   end
 end

data/spec/handshake/server_75_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Server draft 75 handshake' do
@@ -7,5 +9,27 @@ RSpec.describe 'Server draft 75 handshake' do
   let(:client_request) { client_handshake_75(@request_params || {}) }
   let(:server_response) { server_handshake_75(@request_params || {}) }
 
-  it_should_behave_like 'all server drafts'
+  it_behaves_like 'all server drafts'
+
+  context 'protocol header specified' do
+    let(:handshake) { WebSocket::Handshake::Server.new(protocols: %w[binary]) }
+
+    context 'supported' do
+      it 'returns with the same protocol' do
+        @request_params = { headers: { 'WebSocket-Protocol' => 'binary' } }
+        handshake << client_request
+
+        expect(handshake.to_s).to match('WebSocket-Protocol: binary')
+      end
+    end
+
+    context 'unsupported' do
+      it 'returns with an empty protocol header' do
+        @request_params = { headers: { 'WebSocket-Protocol' => 'xmpp' } }
+        handshake << client_request
+
+        expect(handshake.to_s).to match("WebSocket-Protocol: \r\n")
+      end
+    end
+  end
 end

data/spec/handshake/server_76_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Server draft 76 handshake' do
@@ -6,41 +8,63 @@ RSpec.describe 'Server draft 76 handshake' do
   let(:client_request) { client_handshake_76(@request_params || {}) }
   let(:server_response) { server_handshake_76(@request_params || {}) }
 
-  it_should_behave_like 'all server drafts'
+  it_behaves_like 'all server drafts'
 
-  it 'should disallow request without spaces in key 1' do
+  it 'disallows request without spaces in key 1' do
     @request_params = { key1: '4@146546xW%0l15' }
     handshake << client_request
 
     expect(handshake).to be_finished
     expect(handshake).not_to be_valid
-    expect(handshake.error).to eql(:invalid_handshake_authentication)
+    expect(handshake.error).to be(:invalid_handshake_authentication)
   end
 
-  it 'should disallow request without spaces in key 2' do
+  it 'disallows request without spaces in key 2' do
     @request_params = { key2: '129985Y31.P00' }
     handshake << client_request
 
     expect(handshake).to be_finished
     expect(handshake).not_to be_valid
-    expect(handshake.error).to eql(:invalid_handshake_authentication)
+    expect(handshake.error).to be(:invalid_handshake_authentication)
   end
 
-  it 'should disallow request with invalid number of spaces or numbers in key 1' do
+  it 'disallows request with invalid number of spaces or numbers in key 1' do
     @request_params = { key1: '4 @1   46546xW%0l 1 5' }
     handshake << client_request
 
     expect(handshake).to be_finished
     expect(handshake).not_to be_valid
-    expect(handshake.error).to eql(:invalid_handshake_authentication)
+    expect(handshake.error).to be(:invalid_handshake_authentication)
   end
 
-  it 'should disallow request with invalid number of spaces or numbers in key 2' do
+  it 'disallows request with invalid number of spaces or numbers in key 2' do
     @request_params = { key2: '12998  5 Y3 1  .P00' }
     handshake << client_request
 
     expect(handshake).to be_finished
     expect(handshake).not_to be_valid
-    expect(handshake.error).to eql(:invalid_handshake_authentication)
+    expect(handshake.error).to be(:invalid_handshake_authentication)
+  end
+
+  context 'protocol header specified' do
+    let(:handshake) { WebSocket::Handshake::Server.new(protocols: %w[binary]) }
+
+    context 'supported' do
+      it 'returns with the same protocol' do
+        @request_params = { headers: { 'Sec-WebSocket-Protocol' => 'binary' } }
+        handshake << client_request
+
+        expect(handshake.to_s).to match('Sec-WebSocket-Protocol: binary')
+      end
+    end
+
+    context 'unsupported' do
+      it 'returns with an empty protocol header' do
+        @request_params = { headers: { 'Sec-WebSocket-Protocol' => 'xmpp' } }
+        handshake << client_request
+
+        expect(handshake.to_s).to match("Sec-WebSocket-Protocol: \r\n")
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
+
 require 'rspec'
-require 'rspec/its'
-require 'webrick'
 
 require 'websocket'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/support/all_client_drafts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.shared_examples_for 'all client drafts' do
   def validate_request
     expect(handshake.to_s).to eql(client_request)
@@ -9,7 +11,7 @@ RSpec.shared_examples_for 'all client drafts' do
     expect(handshake).to be_valid
   end
 
-  it 'should be valid' do
+  it 'is valid' do
     handshake << server_response
 
     expect(handshake.error).to be_nil
@@ -17,92 +19,92 @@ RSpec.shared_examples_for 'all client drafts' do
     expect(handshake).to be_valid
   end
 
-  it 'should return valid version' do
+  it 'returns valid version' do
     expect(handshake.version).to eql(version)
   end
 
-  it 'should return valid host' do
+  it 'returns valid host' do
     @request_params = { host: 'www.test.cc' }
     expect(handshake.host).to eql('www.test.cc')
   end
 
-  it 'should return valid path' do
+  it 'returns valid path' do
     @request_params = { path: '/custom' }
     expect(handshake.path).to eql('/custom')
   end
 
-  it 'should return valid query' do
+  it 'returns valid query' do
     @request_params = { query: 'aaa=bbb' }
     expect(handshake.query).to eql('aaa=bbb')
   end
 
-  it 'should return valid port' do
+  it 'returns valid port' do
     @request_params = { port: 123 }
-    expect(handshake.port).to eql(123)
+    expect(handshake.port).to be(123)
   end
 
-  it 'should return valid headers' do
+  it 'returns valid headers' do
     @request_params = { headers: { 'aaa' => 'bbb' } }
     expect(handshake.headers).to eql('aaa' => 'bbb')
   end
 
-  it 'should parse uri' do
+  it 'parses uri' do
     @request_params = { uri: 'ws://test.example.org:301/test_path?query=true' }
     expect(handshake.host).to eql('test.example.org')
-    expect(handshake.port).to eql(301)
+    expect(handshake.port).to be(301)
     expect(handshake.path).to eql('/test_path')
     expect(handshake.query).to eql('query=true')
   end
 
-  it 'should parse url' do
+  it 'parses url' do
     @request_params = { url: 'ws://test.example.org:301/test_path?query=true' }
     expect(handshake.host).to eql('test.example.org')
-    expect(handshake.port).to eql(301)
+    expect(handshake.port).to be(301)
     expect(handshake.path).to eql('/test_path')
     expect(handshake.query).to eql('query=true')
   end
 
-  it 'should resolve correct path with root server provided' do
+  it 'resolves correct path with root server provided' do
     @request_params = { url: 'ws://test.example.org' }
     expect(handshake.path).to eql('/')
   end
 
-  it 'should return valid response' do
+  it 'returns valid response' do
     validate_request
   end
 
-  it 'should allow custom path' do
+  it 'allows custom path' do
     @request_params = { path: '/custom' }
     validate_request
   end
 
-  it 'should allow query in path' do
+  it 'allows query in path' do
     @request_params = { query: 'test=true' }
     validate_request
   end
 
-  it 'should allow custom port' do
+  it 'allows custom port' do
     @request_params = { port: 123 }
     validate_request
   end
 
-  it 'should allow custom headers' do
+  it 'allows custom headers' do
     @request_params = { headers: { 'aaa' => 'bbb' } }
     validate_request
   end
 
-  it 'should recognize unfinished requests' do
+  it 'recognizes unfinished requests' do
     handshake << server_response[0..-20]
 
     expect(handshake).not_to be_finished
     expect(handshake).not_to be_valid
   end
 
-  it 'should disallow requests with invalid request method' do
+  it 'disallows requests with invalid request method' do
     handshake << server_response.gsub('101', '404')
 
     expect(handshake).to be_finished
     expect(handshake).not_to be_valid
-    expect(handshake.error).to eql(:invalid_status_code)
+    expect(handshake.error).to be(:invalid_status_code)
   end
 end

data/spec/support/all_server_drafts.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'webrick'
+
 RSpec.shared_examples_for 'all server drafts' do
   def validate_request
     handshake << client_request
@@ -8,7 +12,7 @@ RSpec.shared_examples_for 'all server drafts' do
     expect(handshake.to_s).to eql(server_response)
   end
 
-  it 'should be valid' do
+  it 'is valid' do
     handshake << client_request
 
     expect(handshake.error).to be_nil
@@ -16,86 +20,87 @@ RSpec.shared_examples_for 'all server drafts' do
     expect(handshake).to be_valid
   end
 
-  it 'should return valid version' do
+  it 'returns valid version' do
     handshake << client_request
 
     expect(handshake.version).to eql(version)
   end
 
-  it 'should return valid host' do
+  it 'returns valid host' do
     @request_params = { host: 'www.test.cc' }
     handshake << client_request
 
     expect(handshake.host).to eql('www.test.cc')
   end
 
-  it 'should return valid path' do
+  it 'returns valid path' do
     @request_params = { path: '/custom' }
     handshake << client_request
 
     expect(handshake.path).to eql('/custom')
   end
 
-  it 'should return valid query' do
+  it 'returns valid query' do
     @request_params = { path: '/custom?aaa=bbb' }
     handshake << client_request
 
     expect(handshake.query).to eql('aaa=bbb')
   end
 
-  it 'should return valid port' do
+  it 'returns valid port' do
     @request_params = { port: 123 }
     handshake << client_request
 
     expect(handshake.port).to eql('123')
   end
 
-  it 'should return valid response' do
+  it 'returns valid response' do
     validate_request
   end
 
-  it 'should allow custom path' do
+  it 'allows custom path' do
     @request_params = { path: '/custom' }
     validate_request
   end
 
-  it 'should allow query in path' do
+  it 'allows query in path' do
     @request_params = { path: '/custom?test=true' }
     validate_request
   end
 
-  it 'should allow custom port' do
+  it 'allows custom port' do
     @request_params = { port: 123 }
     validate_request
   end
 
-  it 'should recognize unfinished requests' do
+  it 'recognizes unfinished requests' do
     handshake << client_request[0..-10]
 
     expect(handshake).not_to be_finished
     expect(handshake).not_to be_valid
   end
 
-  it 'should disallow requests with invalid request method' do
+  it 'disallows requests with invalid request method' do
     handshake << client_request.gsub('GET', 'POST')
 
     expect(handshake).to be_finished
     expect(handshake).not_to be_valid
-    expect(handshake.error).to eql(:get_request_required)
+    expect(handshake.error).to be(:get_request_required)
   end
 
-  it 'should parse a rack request' do
+  it 'parses a rack request' do
     request = WEBrick::HTTPRequest.new(ServerSoftware: 'rspec')
     expect(request.parse(StringIO.new(client_request))).to be true
     rest = client_request.slice((request.to_s.length..-1))
 
     handshake.from_rack(request.meta_vars.merge(
-                          'rack.input' => StringIO.new(rest)
+                          'rack.input' => StringIO.new(rest),
+                          :random_key => :random_value
     ))
     validate_request
   end
 
-  it 'should parse a hash request' do
+  it 'parses a hash request' do
     request = WEBrick::HTTPRequest.new(ServerSoftware: 'rspec')
     expect(request.parse(StringIO.new(client_request))).to be true
     body = client_request.slice((request.to_s.length..-1))