websocket 1.2.3 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 48ee0f12aaa5fd6aba76f7c2070a09f600c53204
-  data.tar.gz: d011719667dc6227eecf743a764d0f24f7bf17b2
+SHA256:
+  metadata.gz: 7060e7e52081f894382fcfd1d67a8f3eda15b3b0c86abf4e5dea1f44e6f1c204
+  data.tar.gz: 93981161e7d5ded1e8182d67dd357ffc9a4c606b6bbbe6e84e7c03244db0a949
 SHA512:
-  metadata.gz: 568b9cd4986500c8c9ddf5ec2d8f90b81b654fd6b10451480209ca505be73e0d8a24b11b10040aa7bd3211c84bf6c25154482655985a117705657e75eb302e0f
-  data.tar.gz: 3c3c8d8c324b480654891f7326f1cf7153dbf3f7b4838c1b3ad2bbe670ba25c57dc2485092b049f5d5fd35b1f131a63882a46b989f684fc40a3925fc3d2024bb
+  metadata.gz: b260ffa5fac7b49981fd876ebc6adc55ced481e84fce368b8d974565edd431b9b4c563c718e889c7fd6eb28f80d8a2f20f2734d0d261610068c2f37e40c380be
+  data.tar.gz: d3c905e52be9abe45ac1f8575b31876d7efffcebc1554a124620c6b19b7d2b4b38037a2a0c5bc2a181532af79b484ea951dfb47864aecd3c6a00686f929246d1

data/.codeclimate.yml

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

data/.github/workflows/publish.yml

@@ -0,0 +1,17 @@
+name: Publish Gem
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Release Gem
+        uses: cadwallion/publish-rubygems-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/.rubocop.yml

@@ -1,3 +1,16 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.1
+
+# New version of Rubocop does not support 2.0
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false
+
 # Target: 15
 Metrics/AbcSize:
   Max: 24
@@ -5,6 +18,10 @@ Metrics/AbcSize:
     - lib/websocket/frame/handler/handler75.rb
     - spec/**/*
 
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
 Metrics/ClassLength:
   Enabled: false
 
@@ -30,8 +47,23 @@ Metrics/PerceivedComplexity:
     - lib/websocket/frame/handler/handler75.rb
     - spec/support/handshake_requests.rb
 
-Style/Documentation:
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/ExampleLength:
   Enabled: false
 
-Style/TrivialAccessors:
-  AllowPredicates: true
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 1.2.9
+
+- avoid ruby -w warnings
+
+## 1.2.8
+
+- restore support for Ruby 2.0+
+
+## 1.2.7
+
+- fix bug in previous version for Ruby 2.3
+
+## 1.2.6
+
+- duplicate variables passed in initializers to avoid changing them
+
+## 1.2.5
+
+- make handshake server resilient to non-string Rack env keys
+
+## 1.2.4
+
+- add subprotocol handling for both server and client
+
 ## 1.2.3
 
 - fix for draft 76 when challenge might sometimes fail

data/Gemfile

@@ -1,7 +1,15 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
-gemspec
+group :development do
+  gem 'rake'
+  gem 'rspec', '~> 3.7'
 
-gem 'rake'
-gem 'rspec', '~> 3.0.0'
-gem 'rspec-its'
+  # Use same version as Code Climate for consistency with CI
+  # https://github.com/codeclimate/codeclimate-rubocop/blob/master/Gemfile.lock
+  gem 'rubocop', '0.52.1', require: false
+  gem 'rubocop-rspec', '1.21.0', require: false
+end
+
+gemspec

data/README.md

@@ -3,8 +3,9 @@
 Universal Ruby library to handle WebSocket protocol. It focuses on providing abstraction layer over [WebSocket API](http://dev.w3.org/html5/websockets/) instead of providing server or client functionality.
 
 [![Gem Version](https://badge.fury.io/rb/websocket.svg)](http://badge.fury.io/rb/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)
+[![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.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

@@ -1,14 +1,19 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+# frozen_string_literal: true
 
+require 'bundler'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+Bundler::GemHelper.install_tasks
 
 RSpec::Core::RakeTask.new do |t|
   t.rspec_opts = ['-c', '-f progress']
   t.pattern = 'spec/**/*_spec.rb'
 end
 
-task default: :spec
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
 
 namespace :autobahn do
   desc 'Run autobahn tests for client'

data/lib/websocket.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WebSocket protocol implementation in Ruby
 # This module does not provide a WebSocket server or client, but is made for using
 # in http servers or clients to provide WebSocket support.
@@ -6,12 +8,13 @@
 module WebSocket
   # Default WebSocket version to use
   DEFAULT_VERSION = 13
-  ROOT = File.expand_path(File.dirname(__FILE__))
+  ROOT = __dir__
 
   autoload :Error,            "#{ROOT}/websocket/error"
   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/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   class Error < RuntimeError
     class Frame < ::WebSocket::Error
@@ -99,6 +101,12 @@ module WebSocket
         end
       end
 
+      class UnsupportedProtocol < ::WebSocket::Error::Handshake
+        def message
+          :unsupported_protocol
+        end
+      end
+
       class InvalidStatusCode < ::WebSocket::Error::Handshake
         def message
           :invalid_status_code

data/lib/websocket/exception_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module ExceptionHandler
     attr_accessor :error
@@ -12,7 +14,7 @@ module WebSocket
       # @param [String] method_name Name of method that should be wrapped and rescued
       # @param [Hash] options Options for rescue
       #
-      # @options options [Any] :return Value that should be returned instead of raised error
+      # @option options [Any] :return Value that should be returned instead of raised error
       def rescue_method(method_name, options = {})
         define_method "#{method_name}_with_rescue" do |*args|
           begin

data/lib/websocket/frame.rb

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

data/lib/websocket/frame/base.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Frame
     # @abstract Subclass and override to implement custom frames
     class Base
       include ExceptionHandler
+      include NiceInspect
 
       attr_reader :type, :version, :error
       attr_accessor :data, :code
@@ -36,14 +39,7 @@ module WebSocket
 
       # Implement in submodules
       def supported_frames
-        fail 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}>"
+        raise NotImplementedError
       end
 
       private
@@ -58,7 +54,7 @@ module WebSocket
                    when 4 then Handler::Handler04.new(self)
                    when 5..6 then Handler::Handler05.new(self)
                    when 7..13 then Handler::Handler07.new(self)
-                   else fail WebSocket::Error::Frame::UnknownVersion
+                   else raise WebSocket::Error::Frame::UnknownVersion
                    end
       end
     end

data/lib/websocket/frame/data.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Frame
     class Data < String
       def initialize(*args)
         super(*convert_args(args))
+        @masking_key = nil
       end
 
       def <<(*args)
@@ -11,12 +14,12 @@ module WebSocket
 
       # Convert all arguments to ASCII-8BIT for easier traversing
       def convert_args(args)
-        args.each { |arg| arg.force_encoding('ASCII-8BIT') }
+        args.collect { |arg| arg.dup.force_encoding('ASCII-8BIT') }
       end
 
       # Extract mask from 4 first bytes according to spec
       def set_mask
-        fail WebSocket::Error::Frame::MaskTooShort if bytesize < 4
+        raise WebSocket::Error::Frame::MaskTooShort if bytesize < 4
         @masking_key = self[0..3].bytes.to_a
       end
 

data/lib/websocket/frame/handler.rb

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebSocket
   module Frame
     module Handler
@@ -9,13 +11,13 @@ module WebSocket
         # Convert data to raw frame ready to send to client
         # @return [String] Encoded frame
         def encode_frame
-          fail NotImplementedError
+          raise NotImplementedError
         end
 
         # Convert raw data to decoded frame
         # @return [WebSocket::Frame::Incoming] Frame if found, nil otherwise
         def decode_frame
-          fail NotImplementedError
+          raise NotImplementedError
         end
 
         private
@@ -24,14 +26,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,6 @@
 # encoding: binary
+# frozen_string_literal: true
+
 require 'securerandom'
 
 module WebSocket
@@ -13,14 +15,19 @@ module WebSocket
           pong: 3,
           text: 4,
           binary: 5
-        }
+        }.freeze
 
         # Hash of frame opcodes and it's names
-        FRAME_TYPES_INVERSE = FRAME_TYPES.invert
+        FRAME_TYPES_INVERSE = FRAME_TYPES.invert.freeze
+
+        def initialize(frame)
+          super
+          @application_data_buffer = nil
+        end
 
         # @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
@@ -50,7 +57,7 @@ module WebSocket
             elsif frame_type == :continuation
               return decode_finish_continuation_frame(application_data)
             else
-              fail(WebSocket::Error::Frame::InvalidPayloadEncoding) if frame_type == :text && !application_data.valid_encoding?
+              raise(WebSocket::Error::Frame::InvalidPayloadEncoding) if frame_type == :text && !application_data.valid_encoding?
               return @frame.class.new(version: @frame.version, type: frame_type, data: application_data, decoded: true)
             end
           end
@@ -74,7 +81,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
@@ -82,20 +89,20 @@ 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
 
         def encode_header
           mask = @frame.outgoing_masking? ? 0b10000000 : 0b00000000
 
-          output = ''
+          output = String.new('')
           output << (type_to_opcode(@frame.type) | (fin ? 0b10000000 : 0b00000000)) # since more, rsv1-3 are 0 and 0x80 for Draft 4
           output << encode_payload_length(@frame.data.size, mask)
           output
         end
 
         def encode_payload_length(length, mask)
-          output = ''
+          output = String.new('')
           if length <= 125
             output << (length | mask) # since rsv4 is 0
           elsif length < 65_536 # write 2 byte length
@@ -117,7 +124,7 @@ module WebSocket
           frame_length = header_length + payload_length
           frame_length += 4 if mask
 
-          fail(WebSocket::Error::Frame::TooLong) if frame_length > WebSocket.max_frame_size
+          raise(WebSocket::Error::Frame::TooLong) if frame_length > WebSocket.max_frame_size
 
           # Check buffer size
           return unless buffer_exists?(frame_length) # Buffer incomplete
@@ -135,13 +142,13 @@ module WebSocket
         def decode_first_byte
           first_byte = @frame.data.getbyte(0)
 
-          fail(WebSocket::Error::Frame::ReservedBitUsed) if first_byte & 0b01110000 != 0b00000000
+          raise(WebSocket::Error::Frame::ReservedBitUsed) if first_byte & 0b01110000 != 0b00000000
 
           more = ((first_byte & 0b10000000) == 0b10000000) ^ fin
           frame_type = opcode_to_type first_byte & 0b00001111
 
-          fail(WebSocket::Error::Frame::FragmentedControlFrame) if more && control_frame?(frame_type)
-          fail(WebSocket::Error::Frame::DataFrameInsteadContinuation) if data_frame?(frame_type) && !@application_data_buffer.nil?
+          raise(WebSocket::Error::Frame::FragmentedControlFrame) if more && control_frame?(frame_type)
+          raise(WebSocket::Error::Frame::DataFrameInsteadContinuation) if data_frame?(frame_type) && !@application_data_buffer.nil?
 
           [more, frame_type]
         end
@@ -152,7 +159,7 @@ module WebSocket
           mask = @frame.incoming_masking? && (second_byte & 0b10000000) == 0b10000000
           length = second_byte & 0b01111111
 
-          fail(WebSocket::Error::Frame::ControlFramePayloadTooLong) if length > 125 && control_frame?(frame_type)
+          raise(WebSocket::Error::Frame::ControlFramePayloadTooLong) if length > 125 && control_frame?(frame_type)
 
           header_length, payload_length = decode_payload_length(length)
 
@@ -196,16 +203,16 @@ module WebSocket
         end
 
         def decode_continuation_frame(application_data, frame_type)
-          @application_data_buffer ||= ''
+          @application_data_buffer ||= String.new('')
           @application_data_buffer << application_data
           @frame_type ||= frame_type
         end
 
         def decode_finish_continuation_frame(application_data)
-          fail(WebSocket::Error::Frame::UnexpectedContinuationFrame) unless @frame_type
+          raise(WebSocket::Error::Frame::UnexpectedContinuationFrame) unless @frame_type
           @application_data_buffer << application_data
           # Test valid UTF-8 encoding
-          fail(WebSocket::Error::Frame::InvalidPayloadEncoding) if @frame_type == :text && !@application_data_buffer.valid_encoding?
+          raise(WebSocket::Error::Frame::InvalidPayloadEncoding) if @frame_type == :text && !@application_data_buffer.valid_encoding?
           message = @frame.class.new(version: @frame.version, type: @frame_type, data: @application_data_buffer, decoded: true)
           @application_data_buffer = nil
           @frame_type = nil