websocket 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bf1d6b28aadb7224c53978094d179673364550a
-  data.tar.gz: 0d376d27450259b680f585c8ff9dc56a7d3e5210
+  metadata.gz: d1beb710905d152c983423d7119156b054b515c3
+  data.tar.gz: e74c5149d1ff19ff7b5ed25a499c0d2b2d3bef4b
 SHA512:
-  metadata.gz: 0ab8110e8e84a36c606da58933b48b89e9df724dc145b4ac4d7cbe36f51c6c56f02ece9ad077103be2fba3d4c617c19692f0a2e1934037a39bf50bb47c81c6c1
-  data.tar.gz: 7239ff151df05fb67c67a713c6485377a1e0ab13446a945cef84497979aab255c18a09eaa794cc068da59e44d9f7f536af6d8bfe8dc75cd8fa3d70d1b9f43dcf
+  metadata.gz: 2ec8c925807edd84216c70bfdc7947f9d24c5f37d9ca4eb11274f8f32d99bd0e405b7fe3ad405d1ad835318a18ef9aaf0256bf4d0996ef6bedbdf89455b2b6e0
+  data.tar.gz: 8a64ac2c2bb7da84c15afe43df803abc14d90a6d7e65d358f7a52b909c663a2fab1641c14e0d2666ed5d712f2e6c0bae97dd1ce31818fd48dbde77184bf7e855

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/

data/.rubocop.yml

@@ -1,5 +1,8 @@
+require: rubocop-rspec
+
 AllCops:
   DisplayCopNames: true
+  TargetRubyVersion: 2.1
 
 # Target: 15
 Metrics/AbcSize:
@@ -37,8 +40,20 @@ Metrics/PerceivedComplexity:
     - lib/websocket/frame/handler/handler75.rb
     - spec/support/handshake_requests.rb
 
-Style/Documentation:
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/InstanceVariable:
   Enabled: false
 
-Style/TrivialAccessors:
-  AllowPredicates: true
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -1,23 +1,21 @@
+dist: trusty
 language: ruby
 script: "bundle exec rake"
 rvm:
-  - 1.9.3
-  - 2.0
   - 2.1
   - 2.2
   - 2.3
+  - 2.4
   - ruby-head
-  - jruby
+  - jruby-9.1.9.0 # https://github.com/travis-ci/travis-ci/issues/8446
   - jruby-head
-  - rbx
-  - rbx-head
+  - rbx-3
 
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx
-    - rvm: rbx-head
+    - rvm: rbx-3
 
 before_install:
-  - gem install bundler
+  - gem update bundler

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.2.5
+
+- make handshake server resilient to non-string Rack env keys
+
 ## 1.2.4
 
 - add subprotocol handling for both server and client

data/Gemfile

@@ -1,3 +1,13 @@
 source 'http://rubygems.org'
 
+group :development do
+  gem 'rake'
+  gem 'rspec', '~> 3.0'
+
+  # Use same version as Code Climate for consistency with CI
+  # https://github.com/codeclimate/codeclimate-rubocop/blob/master/Gemfile.lock
+  gem 'rubocop', '0.46.0', require: false
+  gem 'rubocop-rspec', '1.8.0', require: false
+end
+
 gemspec

data/README.md

@@ -4,8 +4,8 @@ Universal Ruby library to handle WebSocket protocol. It focuses on providing abs
 
 [![Gem Version](https://badge.fury.io/rb/websocket.svg)](http://badge.fury.io/rb/websocket)
 [![Gem Downloads](https://img.shields.io/gem/dt/websocket.svg?maxAge=2592000)](https://rubygems.org/gems/websocket)
-[![Travis CI](https://travis-ci.org/imanel/websocket-ruby.png)](http://travis-ci.org/imanel/websocket-ruby)
-[![Code Climate](https://codeclimate.com/github/imanel/websocket-ruby.png)](https://codeclimate.com/github/imanel/websocket-ruby)
+[![Travis CI](https://travis-ci.org/imanel/websocket-ruby.svg)](http://travis-ci.org/imanel/websocket-ruby)
+[![Code Climate](https://codeclimate.com/github/imanel/websocket-ruby.svg)](https://codeclimate.com/github/imanel/websocket-ruby)
 
 **Autobahn tests:** [server](http://imanel.github.com/websocket-ruby/autobahn/server/), [client](http://imanel.github.com/websocket-ruby/autobahn/client/)
 

data/Rakefile

@@ -11,7 +11,7 @@ end
 
 RuboCop::RakeTask.new
 
-task default: [:spec, :rubocop]
+task default: %i(spec rubocop)
 
 namespace :autobahn do
   desc 'Run autobahn tests for client'

data/lib/websocket.rb

@@ -12,6 +12,7 @@ module WebSocket
   autoload :ExceptionHandler, "#{ROOT}/websocket/exception_handler"
   autoload :Frame,            "#{ROOT}/websocket/frame"
   autoload :Handshake,        "#{ROOT}/websocket/handshake"
+  autoload :NiceInspect,      "#{ROOT}/websocket/nice_inspect"
 
   # Limit of frame size payload in bytes
   def self.max_frame_size

data/lib/websocket/frame/base.rb

@@ -3,6 +3,7 @@ module WebSocket
     # @abstract Subclass and override to implement custom frames
     class Base
       include ExceptionHandler
+      include NiceInspect
 
       attr_reader :type, :version, :error
       attr_accessor :data, :code
@@ -39,13 +40,6 @@ module WebSocket
         raise NotImplementedError
       end
 
-      # 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
-
       private
 
       # Include set of methods for selected protocol version

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

@@ -24,14 +24,14 @@ module WebSocket
         # @param [Symbol] frame_type Frame type
         # @return [Boolean] True if given frame type is control frame
         def control_frame?(frame_type)
-          ![:text, :binary, :continuation].include?(frame_type)
+          !%i(text binary continuation).include?(frame_type)
         end
 
         # Check if frame is one of data frames
         # @param [Symbol] frame_type Frame type
         # @return [Boolean] True if given frame type is data frame
         def data_frame?(frame_type)
-          [:text, :binary].include?(frame_type)
+          %i(text binary).include?(frame_type)
         end
       end
     end

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

@@ -1,4 +1,5 @@
 # encoding: binary
+
 require 'securerandom'
 
 module WebSocket
@@ -20,7 +21,7 @@ module WebSocket
 
         # @see WebSocket::Frame::Base#supported_frames
         def supported_frames
-          [:text, :binary, :close, :ping, :pong]
+          %i(text binary close ping pong)
         end
 
         # @see WebSocket::Frame::Handler::Base#encode_frame

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

@@ -6,7 +6,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

data/lib/websocket/handshake/base.rb

@@ -3,6 +3,7 @@ module WebSocket
     # @abstract Subclass and override to implement custom handshakes
     class Base
       include ExceptionHandler
+      include NiceInspect
 
       attr_reader :host, :port, :path, :query,
                   :state, :version, :secure,
@@ -32,13 +33,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?

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

@@ -15,6 +15,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/client04.rb

@@ -48,13 +48,12 @@ module WebSocket
           true
         end
 
-        # Verify if received header Sec-WebSocket-Protocol matches with one of the sent ones
-        # @return [Boolean] True if matching. False otherwise(appropriate error is set)
-        def verify_protocol
-          return true if @handshake.protocols.empty?
-          protos = @handshake.headers['sec-websocket-protocol'].split(/ *, */) & @handshake.protocols
-          raise WebSocket::Error::Handshake::UnsupportedProtocol if protos.empty?
-          true
+        def supported_protocols
+          @handshake.protocols
+        end
+
+        def provided_protocols
+          @handshake.headers['sec-websocket-protocol'].to_s.split(/ *, */)
         end
       end
     end

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

@@ -24,13 +24,12 @@ module WebSocket
           keys
         end
 
-        # Verify if received header WebSocket-Protocol matches with the sent one
-        # @return [Boolean] True if matching. False otherwise(appropriate error is set)
-        def verify_protocol
-          return true if @handshake.protocols.empty?
-          invalid = @handshake.headers['websocket-protocol'].strip != @handshake.protocols.first
-          raise WebSocket::Error::Handshake::UnsupportedProtocol if invalid
-          true
+        def supported_protocols
+          Array(@handshake.protocols.first)
+        end
+
+        def provided_protocols
+          Array(@handshake.headers['websocket-protocol'].to_s.strip)
         end
       end
     end

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

@@ -94,13 +94,8 @@ module WebSocket
           [rand(0x100000000)].pack('N') + [rand(0x100000000)].pack('N')
         end
 
-        # Verify if received header Sec-WebSocket-Protocol matches with the sent one
-        # @return [Boolean] True if matching. False otherwise(appropriate error is set)
-        def verify_protocol
-          return true if @handshake.protocols.empty?
-          invalid = @handshake.headers['sec-websocket-protocol'].strip != @handshake.protocols.first
-          raise WebSocket::Error::Handshake::UnsupportedProtocol if invalid
-          true
+        def provided_protocols
+          Array(@handshake.headers['sec-websocket-protocol'].to_s.strip)
         end
       end
     end

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

@@ -4,6 +4,14 @@ module WebSocket
       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'
@@ -14,15 +22,15 @@ module WebSocket
           [
             %w(Upgrade WebSocket),
             %w(Connection Upgrade),
-            ['WebSocket-Origin', @handshake.headers['origin']],
-            ['WebSocket-Location', @handshake.uri]
+            [headers[:origin], @handshake.headers['origin']],
+            [headers[:location], @handshake.uri]
           ] + protocol
         end
 
         def protocol
-          return [] unless @handshake.headers.key?('websocket-protocol')
-          proto = @handshake.headers['websocket-protocol']
-          [['WebSocket-Protocol', @handshake.protocols.include?(proto) ? proto : nil]]
+          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

@@ -3,7 +3,7 @@ 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 +11,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,16 +29,6 @@ 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]
-          ] + protocol
-        end
-
         # @see WebSocket::Handshake::Handler::Base#finishing_line
         def finishing_line
           @finishing_line ||= challenge_response
@@ -69,12 +67,6 @@ module WebSocket
 
           quotient
         end
-
-        def protocol
-          return [] unless @handshake.headers.key?('sec-websocket-protocol')
-          proto = @handshake.headers['sec-websocket-protocol']
-          [['Sec-WebSocket-Protocol', @handshake.protocols.include?(proto) ? proto : nil]]
-        end
       end
     end
   end

data/lib/websocket/handshake/server.rb

@@ -71,7 +71,7 @@ module WebSocket
       # @example
       #   @handshake.from_rack(env)
       def from_rack(env)
-        @headers = env.select { |key, _value| key.start_with? 'HTTP_' }.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

data/lib/websocket/nice_inspect.rb

@@ -0,0 +1,10 @@
+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,3 @@
 module WebSocket
-  VERSION = '1.2.4'.freeze
+  VERSION = '1.2.5'.freeze
 end

data/spec/frame/incoming_03_spec.rb

@@ -1,14 +1,15 @@
 # encoding: binary
+
 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'
 
@@ -54,7 +55,7 @@ RSpec.describe 'Incoming frame draft 03' do
 
   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(:frame_type)   { %i(pong text) }
     let(:decoded_text) { %w(abc Hello) }
 
     it_should_behave_like 'valid_incoming_frame'