websocket 1.2.3 → 1.2.9

data/spec/frame/outgoing_04_spec.rb

@@ -1,17 +1,20 @@
 # encoding: binary
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Outgoing frame draft 04' do
-  let(:version) { 04 }
+  subject { frame }
+
+  let(:version) { 4 }
   let(:frame) { WebSocket::Frame::Outgoing.new(version: version, data: decoded_text, type: frame_type) }
   let(:decoded_text) { '' }
   let(:encoded_text) { "\x84\x00" }
   let(:frame_type) { :text }
   let(:require_sending) { true }
   let(:error) { nil }
-  subject { frame }
 
-  it_should_behave_like 'valid_outgoing_frame'
+  it_behaves_like 'valid_outgoing_frame'
 
   context 'should properly encode close frame' do
     let(:frame_type) { :close }
@@ -19,7 +22,7 @@ RSpec.describe 'Outgoing frame draft 04' do
     let(:encoded_text) { "\x81\x05" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode ping frame' do
@@ -28,7 +31,7 @@ RSpec.describe 'Outgoing frame draft 04' do
     let(:encoded_text) { "\x82\x05" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode pong frame' do
@@ -37,7 +40,7 @@ RSpec.describe 'Outgoing frame draft 04' do
     let(:encoded_text) { "\x83\x05" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode text frame' do
@@ -45,7 +48,7 @@ RSpec.describe 'Outgoing frame draft 04' do
     let(:encoded_text) { "\x84\x05" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode 256 bytes binary frame' do
@@ -54,7 +57,7 @@ RSpec.describe 'Outgoing frame draft 04' do
     let(:encoded_text) { "\x85\x7E\x01\x00" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode 64KiB binary frame' do
@@ -63,7 +66,7 @@ RSpec.describe 'Outgoing frame draft 04' do
     let(:encoded_text) { "\x85\x7F\x00\x00\x00\x00\x00\x01\x00\x00" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should return error for unknown frame type' do
@@ -73,6 +76,6 @@ RSpec.describe 'Outgoing frame draft 04' do
     let(:error) { :unknown_frame_type }
     let(:require_sending) { false }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 end

data/spec/frame/outgoing_05_spec.rb

@@ -1,7 +1,11 @@
 # encoding: binary
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Outgoing frame draft 05' do
+  subject { frame }
+
   let(:version) { 5 }
   let(:frame) { WebSocket::Frame::Outgoing.new(version: version, data: decoded_text, type: frame_type) }
   let(:decoded_text) { '' }
@@ -9,9 +13,8 @@ RSpec.describe 'Outgoing frame draft 05' do
   let(:frame_type) { :text }
   let(:require_sending) { true }
   let(:error) { nil }
-  subject { frame }
 
-  it_should_behave_like 'valid_outgoing_frame'
+  it_behaves_like 'valid_outgoing_frame'
 
   context 'should properly encode close frame' do
     let(:frame_type) { :close }
@@ -19,7 +22,7 @@ RSpec.describe 'Outgoing frame draft 05' do
     let(:encoded_text) { "\x81\x05" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode ping frame' do
@@ -28,7 +31,7 @@ RSpec.describe 'Outgoing frame draft 05' do
     let(:encoded_text) { "\x82\x05" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode pong frame' do
@@ -37,7 +40,7 @@ RSpec.describe 'Outgoing frame draft 05' do
     let(:encoded_text) { "\x83\x05" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode text frame' do
@@ -45,7 +48,7 @@ RSpec.describe 'Outgoing frame draft 05' do
     let(:encoded_text) { "\x84\x05" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode 256 bytes binary frame' do
@@ -54,7 +57,7 @@ RSpec.describe 'Outgoing frame draft 05' do
     let(:encoded_text) { "\x85\x7E\x01\x00" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode 64KiB binary frame' do
@@ -63,7 +66,7 @@ RSpec.describe 'Outgoing frame draft 05' do
     let(:encoded_text) { "\x85\x7F\x00\x00\x00\x00\x00\x01\x00\x00" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should return error for unknown frame type' do
@@ -73,6 +76,6 @@ RSpec.describe 'Outgoing frame draft 05' do
     let(:error) { :unknown_frame_type }
     let(:require_sending) { false }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 end

data/spec/frame/outgoing_07_spec.rb

@@ -1,7 +1,11 @@
 # encoding: binary
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Outgoing frame draft 07' do
+  subject { frame }
+
   let(:version) { 7 }
   let(:frame) { WebSocket::Frame::Outgoing.new(version: version, data: decoded_text, type: frame_type, code: close_code) }
   let(:decoded_text) { '' }
@@ -10,9 +14,8 @@ RSpec.describe 'Outgoing frame draft 07' do
   let(:frame_type) { :text }
   let(:require_sending) { true }
   let(:error) { nil }
-  subject { frame }
 
-  it_should_behave_like 'valid_outgoing_frame'
+  it_behaves_like 'valid_outgoing_frame'
 
   context 'should properly encode close frame without close code' do
     let(:frame_type) { :close }
@@ -20,7 +23,7 @@ RSpec.describe 'Outgoing frame draft 07' do
     let(:encoded_text) { "\x88\x07\x03\xE8" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode close frame with close code' do
@@ -30,7 +33,7 @@ RSpec.describe 'Outgoing frame draft 07' do
     let(:encoded_text) { "\x88\x07\x03\xE9" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode ping frame' do
@@ -39,7 +42,7 @@ RSpec.describe 'Outgoing frame draft 07' do
     let(:encoded_text) { "\x89\x05" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode pong frame' do
@@ -48,7 +51,7 @@ RSpec.describe 'Outgoing frame draft 07' do
     let(:encoded_text) { "\x8a\x05" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode text frame' do
@@ -56,7 +59,7 @@ RSpec.describe 'Outgoing frame draft 07' do
     let(:encoded_text) { "\x81\x05" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode 256 bytes binary frame' do
@@ -65,7 +68,7 @@ RSpec.describe 'Outgoing frame draft 07' do
     let(:encoded_text) { "\x82\x7E\x01\x00" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode 64KiB binary frame' do
@@ -74,7 +77,7 @@ RSpec.describe 'Outgoing frame draft 07' do
     let(:encoded_text) { "\x82\x7F\x00\x00\x00\x00\x00\x01\x00\x00" + decoded_text }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should return error for unknown frame type' do
@@ -84,6 +87,6 @@ RSpec.describe 'Outgoing frame draft 07' do
     let(:error) { :unknown_frame_type }
     let(:require_sending) { false }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 end

data/spec/frame/outgoing_75_spec.rb

@@ -1,7 +1,11 @@
 # encoding: binary
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Outgoing frame draft 75' do
+  subject { frame }
+
   let(:version) { 75 }
   let(:frame) { WebSocket::Frame::Outgoing.new(version: version, data: decoded_text, type: frame_type) }
   let(:decoded_text) { '' }
@@ -9,16 +13,15 @@ RSpec.describe 'Outgoing frame draft 75' do
   let(:frame_type) { :text }
   let(:require_sending) { true }
   let(:error) { nil }
-  subject { frame }
 
-  it_should_behave_like 'valid_outgoing_frame'
+  it_behaves_like 'valid_outgoing_frame'
 
   context 'should properly encode text frame' do
     let(:decoded_text) { 'abc' }
     let(:encoded_text) { "\x00abc\xFF" }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should properly encode close frame' do
@@ -27,7 +30,7 @@ RSpec.describe 'Outgoing frame draft 75' do
     let(:encoded_text) { "\xFF\x00" }
     let(:require_sending) { true }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 
   context 'should return error for unknown frame type' do
@@ -37,6 +40,6 @@ RSpec.describe 'Outgoing frame draft 75' do
     let(:error) { :unknown_frame_type }
     let(:require_sending) { false }
 
-    it_should_behave_like 'valid_outgoing_frame'
+    it_behaves_like 'valid_outgoing_frame'
   end
 end

data/spec/frame/outgoing_common_spec.rb

@@ -1,15 +1,22 @@
 # encoding: binary
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Outgoing common frame' do
   subject { WebSocket::Frame::Outgoing.new }
 
-  its(:version) { is_expected.to eql(13) }
-  its(:error?) { is_expected.to be false }
+  it 'is version 13' do
+    expect(subject.version).to be 13
+  end
+
+  it 'has no errors' do
+    expect(subject.error?).to be false
+  end
 
-  it 'should raise error on invalid version' do
+  it 'raises error on invalid version' do
     subject = WebSocket::Frame::Incoming.new(version: 70)
     expect(subject.error?).to be true
-    expect(subject.error).to eql(:unknown_protocol_version)
+    expect(subject.error).to be :unknown_protocol_version
   end
 end

data/spec/handshake/client_04_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Client draft 4 handshake' do
@@ -7,14 +9,55 @@ RSpec.describe 'Client draft 4 handshake' do
   let(:client_request) { client_handshake_04({ key: handshake.handler.send(:key), version: version }.merge(@request_params || {})) }
   let(:server_response) { server_handshake_04({ accept: handshake.handler.send(:accept) }.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 = { accept: '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: protocols) }
+
+    context 'single protocol requested' do
+      let(:protocols) { %w[binary] }
+
+      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 'multiple protocols requested' do
+      let(:protocols) { %w[binary xmpp] }
+
+      it 'returns with a valid handshake' do
+        @request_params = { headers: { 'Sec-WebSocket-Protocol' => 'xmpp' } }
+        handshake << server_response
+
+        expect(handshake).to be_finished
+        expect(handshake).to be_valid
+      end
+    end
+
+    context 'unsupported protocol requested' do
+      let(:protocols) { %w[binary xmpp] }
+
+      it 'fails with an unsupported protocol error' do
+        @request_params = { headers: { 'Sec-WebSocket-Protocol' => 'generic' } }
+        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/client_11_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Client draft 11 handshake' do
@@ -7,14 +9,14 @@ RSpec.describe 'Client draft 11 handshake' do
   let(:client_request) { client_handshake_11({ key: handshake.handler.send(:key), version: version }.merge(@request_params || {})) }
   let(:server_response) { server_handshake_11({ accept: handshake.handler.send(:accept) }.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 = { accept: '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
 end

data/spec/handshake/client_75_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'Client draft 75 handshake' do
@@ -7,5 +9,30 @@ RSpec.describe 'Client 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 client drafts'
+  it_behaves_like 'all client drafts'
+
+  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: { '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: { '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