websocket 1.2.8 → 1.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc36fa232460616657d774b6ae0d21bac79c8123730812ac1032d185a4fa090a
-  data.tar.gz: 125432097dd592f40606fd4e2d7fb30f1b029b794b832eda0d2f0e9f4b1d824a
+  metadata.gz: 4463e6e6f36b66267381b20c6dbab2fc1fd417319fcc9d2fb1a760c87a7d26e6
+  data.tar.gz: 71187172f0f75a938c50573cf0b2b378f092ec93f42b57cacea5c73f559ba085
 SHA512:
-  metadata.gz: 825c8e711023468f699cf0cf0a0f9e1ce462a81bc2ca5ea1a1523b079548bd21d9ac9bc0938d47d154a3e4706c23ff71e9abd93612ec9e83f3b1063651e7e7bb
-  data.tar.gz: 66a68866a9c231658d7cdd203250a4c1cab1d860b4fe2523343d77fd7969f48fc86471cc0920795fe52499ee3aa93825294a1651ab6968ca76839ee2ec34d200
+  metadata.gz: 9875cb5996d580b1564e4a6cf2ef897ccf99d37577d2a22dd1e7750323dfc5aad181641411596b96667ebf614604d0ff581e3b39ae75d49c2bc1290c1ec4a82d
+  data.tar.gz: fd772c288aee75ca9c7328fd8096bc30bde61a69247633a4b9a2a7e61dff260d48bd4abbf957a02ead55ac83c365d945f3753b053c9e6f5cf237925b2c510a06

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/.github/workflows/test.yml

@@ -0,0 +1,61 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - 'master'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    name: Rubocop
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Run Rubocop
+        run: bundle exec rubocop
+
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.1
+          - 2.3
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - "3.0"
+          - 3.1
+          - 3.2
+          - 3.3
+          - jruby
+
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## Edge
+
+## 1.2.10
+
+- ensure correct port is always specified for handshake
+- no longer using Base64 for compatibility with Ruby 3.4+
+
+## 1.2.9
+
+- avoid ruby -w warnings
+
 ## 1.2.8
 
 - restore support for Ruby 2.0+

data/Gemfile

@@ -5,6 +5,7 @@ source 'http://rubygems.org'
 group :development do
   gem 'rake'
   gem 'rspec', '~> 3.7'
+  gem 'webrick'
 
   # Use same version as Code Climate for consistency with CI
   # https://github.com/codeclimate/codeclimate-rubocop/blob/master/Gemfile.lock

data/README.md

@@ -4,7 +4,6 @@ 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.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/)
@@ -118,6 +117,14 @@ WebSocket gem is written in pure Ruby, without any dependencies or native extens
 
 In order to use native extension just install [websocket-native](http://github.com/imanel/websocket-ruby-native) gem or add it to Gemfile - WebSocket will automatically detect and load it.
 
+## Support
+
+If you like my work then consider supporting me:
+
+[![Donate with Bitcoin](https://en.cryptobadges.io/badge/small/bc1qmxfc703ezscvd4qv0dvp7hwy7vc4kl6currs5e)](https://en.cryptobadges.io/donate/bc1qmxfc703ezscvd4qv0dvp7hwy7vc4kl6currs5e)
+
+[![Donate with Ethereum](https://en.cryptobadges.io/badge/small/0xA7048d5F866e2c3206DC95ebFa988fF987c0BccB)](https://en.cryptobadges.io/donate/0xA7048d5F866e2c3206DC95ebFa988fF987c0BccB)
+
 ## License
 
 (The MIT License)

data/lib/websocket/exception_handler.rb

@@ -14,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/data.rb

@@ -5,6 +5,7 @@ module WebSocket
     class Data < String
       def initialize(*args)
         super(*convert_args(args))
+        @masking_key = nil
       end
 
       def <<(*args)

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

@@ -20,6 +20,11 @@ module WebSocket
         # Hash of frame opcodes and it's names
         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
           %i[text binary close ping pong]

data/lib/websocket/frame/outgoing.rb

@@ -2,7 +2,7 @@
 
 module WebSocket
   module Frame
-    # Construct or parse incoming WebSocket Frame.
+    # Construct or parse outgoing WebSocket Frame.
     # @note You should NEVER use this class directly - use Client or Server subclasses instead, as they contain additional frame options(i.e. Client-side masking in draft 04)
     #
     # @example

data/lib/websocket/handshake/base.rb

@@ -7,7 +7,7 @@ module WebSocket
       include ExceptionHandler
       include NiceInspect
 
-      attr_reader :host, :port, :path, :query,
+      attr_reader :host, :path, :query,
                   :state, :version, :secure,
                   :headers, :protocols
 
@@ -66,6 +66,20 @@ module WebSocket
         (@leftovers.to_s.split("\n", reserved_leftover_lines + 1)[reserved_leftover_lines] || '').strip
       end
 
+      # Return default port for protocol (80 for ws, 443 for wss)
+      def default_port
+        secure ? 443 : 80
+      end
+
+      # Check if provided port is a default one
+      def default_port?
+        port == default_port
+      end
+
+      def port
+        @port || default_port
+      end
+
       # URI of request.
       # @return [String] Full URI with protocol
       # @example
@@ -73,7 +87,7 @@ module WebSocket
       def uri
         uri =  String.new(secure ? 'wss://' : 'ws://')
         uri << host
-        uri << ":#{port}" if port
+        uri << ":#{port}" unless default_port?
         uri << path
         uri << "?#{query}" if query
         uri

data/lib/websocket/handshake/client.rb

@@ -61,7 +61,7 @@ module WebSocket
           uri = URI.parse(@url || @uri)
           @secure ||= (uri.scheme == 'wss')
           @host ||= uri.host
-          @port ||= uri.port
+          @port ||= uri.port || default_port
           @path ||= uri.path
           @query ||= uri.query
         end

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

@@ -21,7 +21,7 @@ module WebSocket
             %w[Connection Upgrade]
           ]
           host = @handshake.host
-          host += ":#{@handshake.port}" if @handshake.port
+          host += ":#{@handshake.port}" unless @handshake.default_port?
           keys << ['Host', host]
           keys += super
           keys << ['Sec-WebSocket-Origin', @handshake.origin] if @handshake.origin
@@ -34,13 +34,13 @@ module WebSocket
         # Sec-WebSocket-Key value
         # @return [String] key
         def key
-          @key ||= Base64.encode64((1..16).map { rand(255).chr } * '').strip
+          @key ||= [(1..16).map { rand(255).chr } * ''].pack('m').strip
         end
 
         # Value of Sec-WebSocket-Accept that should be delivered back by server
         # @return [Sering] accept
         def accept
-          @accept ||= Base64.encode64(Digest::SHA1.digest(key + '258EAFA5-E914-47DA-95CA-C5AB0DC85B11')).strip
+          @accept ||= [Digest::SHA1.digest(key + '258EAFA5-E914-47DA-95CA-C5AB0DC85B11')].pack('m').strip
         end
 
         # Verify if received header Sec-WebSocket-Accept matches generated one.

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

@@ -18,7 +18,7 @@ module WebSocket
             %w[Connection Upgrade]
           ]
           host = @handshake.host
-          host += ":#{@handshake.port}" if @handshake.port
+          host += ":#{@handshake.port}" unless @handshake.default_port?
           keys << ['Host', host]
           keys << ['Origin', @handshake.origin] if @handshake.origin
           keys << ['WebSocket-Protocol', @handshake.protocols.first] if @handshake.protocols.any?

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

@@ -71,7 +71,7 @@ module WebSocket
         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 = rand(1..12)

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

@@ -33,7 +33,7 @@ module WebSocket
         def signature
           return unless key
           string_to_sign = "#{key}258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
-          Base64.encode64(Digest::SHA1.digest(string_to_sign)).chomp
+          [Digest::SHA1.digest(string_to_sign)].pack('m').chomp
         end
 
         def verify_key

data/lib/websocket/handshake/server.rb

@@ -129,13 +129,13 @@ module WebSocket
       # Host of server according to client header
       # @return [String] host
       def host
-        @headers['host'].to_s.split(':')[0].to_s
+        @host || @headers['host'].to_s.split(':')[0].to_s
       end
 
       # Port of server according to client header
-      # @return [String] port
+      # @return [Integer] port
       def port
-        @headers['host'].to_s.split(':')[1]
+        (@port || @headers['host'].to_s.split(':')[1] || default_port).to_i
       end
 
       private

data/lib/websocket/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WebSocket
-  VERSION = '1.2.8'.freeze
+  VERSION = '1.2.10'.freeze
 end

data/spec/support/all_client_drafts.rb

@@ -38,6 +38,10 @@ RSpec.shared_examples_for 'all client drafts' do
     expect(handshake.query).to eql('aaa=bbb')
   end
 
+  it 'returns default port' do
+    expect(handshake.port).to be(80)
+  end
+
   it 'returns valid port' do
     @request_params = { port: 123 }
     expect(handshake.port).to be(123)

data/spec/support/all_server_drafts.rb

@@ -47,11 +47,17 @@ RSpec.shared_examples_for 'all server drafts' do
     expect(handshake.query).to eql('aaa=bbb')
   end
 
+  it 'returns default port' do
+    handshake << client_request
+
+    expect(handshake.port).to be(80)
+  end
+
   it 'returns valid port' do
     @request_params = { port: 123 }
     handshake << client_request
 
-    expect(handshake.port).to eql('123')
+    expect(handshake.port).to be(123)
   end
 
   it 'returns valid response' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: websocket
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.10
 platform: ruby
 authors:
 - Bernard Potocki
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-25 00:00:00.000000000 Z
+date: 2023-09-19 00:00:00.000000000 Z
 dependencies: []
 description: Universal Ruby library to handle WebSocket protocol
 email:
@@ -18,9 +18,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/workflows/publish.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -95,7 +96,7 @@ homepage: http://github.com/imanel/websocket-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,37 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Universal Ruby library to handle WebSocket protocol
-test_files:
-- spec/frame/incoming_03_spec.rb
-- spec/frame/incoming_04_spec.rb
-- spec/frame/incoming_05_spec.rb
-- spec/frame/incoming_07_spec.rb
-- spec/frame/incoming_75_spec.rb
-- spec/frame/incoming_common_spec.rb
-- spec/frame/masking_spec.rb
-- spec/frame/outgoing_03_spec.rb
-- spec/frame/outgoing_04_spec.rb
-- spec/frame/outgoing_05_spec.rb
-- spec/frame/outgoing_07_spec.rb
-- spec/frame/outgoing_75_spec.rb
-- spec/frame/outgoing_common_spec.rb
-- spec/handshake/client_04_spec.rb
-- spec/handshake/client_11_spec.rb
-- spec/handshake/client_75_spec.rb
-- spec/handshake/client_76_spec.rb
-- spec/handshake/server_04_spec.rb
-- spec/handshake/server_75_spec.rb
-- spec/handshake/server_76_spec.rb
-- spec/spec_helper.rb
-- spec/support/all_client_drafts.rb
-- spec/support/all_server_drafts.rb
-- spec/support/frames_base.rb
-- spec/support/handshake_requests.rb
-- spec/support/incoming_frames.rb
-- spec/support/outgoing_frames.rb
-- spec/support/overwrites.rb
+test_files: []

data/.travis.yml

@@ -1,19 +0,0 @@
-dist: trusty
-language: ruby
-script: "bundle exec rake"
-rvm:
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - ruby-head
-  - 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