websocket-client-simple 0.3.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d8831f5be8aa53190a5219b4a245b56722cdc421572d5670958e82962d4fbb1
-  data.tar.gz: 8f59c91e11fa7e672ab5b48f1d1d447a215af4be3891c68f36214a0f893254a0
+  metadata.gz: 7589c208daf3fa057d52cc788dafa63401a1c71dd20413d95e8eae0b42a09251
+  data.tar.gz: 53a1bed22541edce6f7d64ae140873a8d6b454f854f39c9a7a85ac4bcc78313b
 SHA512:
-  metadata.gz: eedeaff30cd560fd44127254696e9a7ee4b5a44fb38fa1d59274a90f744118e2b92c43f6a9cad245f1da431a69f94fc13274ff5dd66d7275261187d0d349481c
-  data.tar.gz: 20c709ce576c3ee020b79f09082d9ba01a0eb28837e0fcf7afedef851ccb63c026e2502e5d236a0a2490cfc4241dc36d2e2c792ef10cc1a24ff5c969e9c53260
+  metadata.gz: 2c80ac0a53fde73ed53bbe6149b911ffbe053f056d87423700dd58fc4bade8a06aa630ec48b0e6018f6ab7d093e2394d590f407e00c019629061b24f1e05ab6f
+  data.tar.gz: fa4c287824fafab4bbca6abc7c23c1a3ca8bb0ff1c0381614f2e579605951870bf2c2850c48bb0c599ae1bb20cc81a319202a89aebe93691e57dccad2bdd6f98

data/.github/workflows/test.yml

@@ -9,13 +9,13 @@ on:
     - cron: "0 0 * * 6" # At 00:00 on Saturday
 jobs:
   test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
-        ruby: ["3.1", "3.0", "2.7", "2.6"]
+        ruby: ["3.2", "3.1", "3.0", "2.7", "2.6"]
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/CHANGELOG.md

@@ -0,0 +1,88 @@
+# Changelog
+
+## Not yet released
+
+## 0.8.0 - 2023-08-08
+* Set `WebSocket.should_raise = true` https://github.com/ruby-jp/websocket-client-simple/pull/25 by @jlaffaye
+
+## 0.7.0 - 2023-08-04
+* Expose add accessor `Client#thread` #22 by @jlaffaye
+* Rewrite changelog as a Markdown
+
+## 0.6.1 - 2023-03-10
+* Make `#open?` safe to use when `@handshake` is `nil` #20 by @cyberarm
+
+## 0.6.0 - 2022-09-22
+* Add option `cert_store` for passing cert store to SSLSocket context #12 by @DerekStride
+* Set `OpenSSL::SSL::SSLSocket#sync_close` to `true` #12 by @DerekStride
+
+## 0.5.1 - 2022-01-01
+* Add `closed?` method to `WebSocket::Client::Simple` #8 by @fuyuton
+* rescue when `OpenSSL::SSL::SSLError` raised #10 by @fuyuton
+
+## 0.5.0 - 2021-12-31
+* Change TLS context defaults to system's default. The previous defaults were `ssl_version=SSLv23` and `verify_mode=VERIFY_NONE`, which are insecure nowadays. #5
+  * thank you for contributing @eagletmt
+* Made the necessary changes to use SNI. #6
+  * thank you for contributing @fuyuton
+
+## 0.4.0 - 2021-12-30
+* Drop support of ruby 2.5 or older versions as explicit.
+
+## 0.3.1 - 2021-12-30
+* The development of this repository has moved to https://github.com/ruby-jp/websocket-client-simple
+
+## 0.3.0 - 2016-12-30
+* `connect` method runs a given block before connecting WebSocket  [#12](https://github.com/shokai/websocket-client-simple/issues/12)
+  * thank you for suggestion @codekitchen
+
+## 0.2.5 - 2016-02-18
+* bugfixed sending when broken pipe [#15](https://github.com/shokai/websocket-client-simple/pull/15)
+* add `:verify_mode` option for SSL Context [#14](https://github.com/shokai/websocket-client-simple/pull/14)
+  * thank you for contributing @michaelvilensky
+
+## 0.2.4 - 2015-11-12
+* support handshake headers  [#11](https://github.com/shokai/websocket-client-simple/pull/11)
+  * thank you for contributing @mathieugagne
+
+## 0.2.3 - 2015-10-26
+* kill thread at end of method [#10](https://github.com/shokai/websocket-client-simple/pull/10)
+  * thank you for contributing @hansy
+
+## 0.2.2 - 2014-11-18
+* bugfix socket reading
+
+## 0.2.0 - 2014-06-07
+* SSL support with `wss://` and `https://` scheme [#6](https://github.com/shokai/websocket-client-simple/pull/6)
+  * thank you for contributing @mallowlabs
+
+## 0.1.0 - 2014-05-08
+* add accessor `Client#handshake` [#5](https://github.com/shokai/websocket-client-simple/issues/5)
+* bugfix socket reading
+
+## 0.0.9 - 2014-04-03
+* emit `error` in receive thread
+* rescue only `Errno::EPIPE`, not all Errors
+
+## 0.0.8 - 2014-01-29
+* bugfix `Client#close` #4
+
+## 0.0.7 - 2014-01-29
+* send CLOSE frame in `Client#close` [#4](https://github.com/shokai/websocket-client-simple/issues/4)
+## 0.0.6 - 2014-01-17
+* add function `Client#open?`
+
+## 0.0.5 - 2013-03-23
+* kill read thread on close
+
+## 0.0.4 - 2013-03-23
+* fix sample and README
+
+## 0.0.3 - 2013-03-23
+* `:type => :text` option in send
+
+## 0.0.2 - 2013-03-22
+* remove unnecessary sleep
+
+## 0.0.1 - 2013-03-22
+* release

data/README.md

@@ -16,7 +16,6 @@ Installation
 Usage
 -----
 ```ruby
-require 'rubygems'
 require 'websocket-client-simple'
 
 ws = WebSocket::Client::Simple.connect 'ws://example.com:8888'
@@ -60,7 +59,7 @@ end
 
 Sample
 ------
-[websocket chat](https://github.com/shokai/websocket-client-simple/tree/master/sample)
+[websocket chat](https://github.com/ruby-jp/websocket-client-simple/tree/master/sample)
 
 
 Test

data/lib/websocket-client-simple/client.rb

@@ -11,7 +11,7 @@ module WebSocket
 
       class Client
         include EventEmitter
-        attr_reader :url, :handshake
+        attr_reader :url, :handshake, :thread
 
         def connect(url, options={})
           return if @socket
@@ -21,14 +21,17 @@ module WebSocket
                                   uri.port || (uri.scheme == 'wss' ? 443 : 80))
           if ['https', 'wss'].include? uri.scheme
             ctx = OpenSSL::SSL::SSLContext.new
-            ctx.ssl_version = options[:ssl_version] || 'SSLv23'
-            ctx.verify_mode = options[:verify_mode] || OpenSSL::SSL::VERIFY_NONE #use VERIFY_PEER for verification
-            cert_store = OpenSSL::X509::Store.new
+            ctx.ssl_version = options[:ssl_version] if options[:ssl_version]
+            ctx.verify_mode = options[:verify_mode] if options[:verify_mode]
+            cert_store = options[:cert_store] || OpenSSL::X509::Store.new
             cert_store.set_default_paths
             ctx.cert_store = cert_store
             @socket = ::OpenSSL::SSL::SSLSocket.new(@socket, ctx)
+            @socket.sync_close = true
+            @socket.hostname = uri.host
             @socket.connect
           end
+          ::WebSocket.should_raise = true
           @handshake = ::WebSocket::Handshake::Client.new :url => url, :headers => options[:headers]
           @handshaked = false
           @pipe_broken = false
@@ -76,6 +79,9 @@ module WebSocket
           rescue Errno::EPIPE => e
             @pipe_broken = true
             emit :__close, e
+          rescue OpenSSL::SSL::SSLError => e
+            @pipe_broken = true
+            emit :__close, e
           end
         end
 
@@ -92,7 +98,11 @@ module WebSocket
         end
 
         def open?
-          @handshake.finished? and !@closed
+          @handshake&.finished? and !@closed
+        end
+
+        def closed?
+          @closed
         end
 
       end

data/lib/websocket-client-simple/version.rb

@@ -1,7 +1,7 @@
 module WebSocket
   module Client
     module Simple
-      VERSION = "0.3.1"
+      VERSION = "0.8.0"
     end
   end
 end

data/sample/client.rb

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 $:.unshift File.expand_path '../lib', File.dirname(__FILE__)
-require 'rubygems'
 require 'websocket-client-simple'
 
 puts "websocket-client-simple v#{WebSocket::Client::Simple::VERSION}"

data/sample/webbrowser/index.html

@@ -16,7 +16,7 @@
     <ul id="chat"></ul>
     <div id="footer">
       <hr>
-      <a href="https://github.com/shokai/websocket-client-simple">https://github.com/shokai/websocket-client-simple</a>
+      <a href="https://github.com/ruby-jp/websocket-client-simple">https://github.com/ruby-jp/websocket-client-simple</a>
     </div>
   </body>
 </html>

data/test/test_connect_block.rb

@@ -1,11 +1,11 @@
 require File.expand_path 'test_helper', File.dirname(__FILE__)
 
-class TestWebSocketClientSimple < MiniTest::Test
-  
+class TestWebSocketClientSimple < Minitest::Test
+
   def test_onopen
-    
+
     EM::run{
-      
+
       EchoServer.start
 
       res = nil
@@ -27,7 +27,7 @@ class TestWebSocketClientSimple < MiniTest::Test
         EM::stop_event_loop
       end
     }
-    
+
   end
-  
+
 end

data/test/test_websocket_client_simple.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-class TestWebSocketClientSimple < MiniTest::Test
+class TestWebSocketClientSimple < Minitest::Test
 
   def test_echo
     msgs = ['foo','bar','baz']

data/websocket-client-simple.gemspec

@@ -11,11 +11,12 @@ Gem::Specification.new do |spec|
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/ruby-jp/websocket-client-simple"
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.6.9'
 
   if spec.respond_to?(:metadata)
     spec.metadata["homepage_uri"] = spec.homepage
     spec.metadata["source_code_uri"] = spec.homepage
-    spec.metadata["changelog_uri"] = "https://github.com/ruby-jp/websocket-client-simple/blob/master/History.txt"
+    spec.metadata["changelog_uri"] = "https://github.com/ruby-jp/websocket-client-simple/blob/master/CHANGELOG.md"
   end
 
   spec.post_install_message = "The development of this gem has moved to #{spec.homepage}."

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: websocket-client-simple
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Sho Hashimoto
 - Yusuke Nakamura
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2023-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,8 +119,8 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/test.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
-- History.txt
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -142,7 +142,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ruby-jp/websocket-client-simple
   source_code_uri: https://github.com/ruby-jp/websocket-client-simple
-  changelog_uri: https://github.com/ruby-jp/websocket-client-simple/blob/master/History.txt
+  changelog_uri: https://github.com/ruby-jp/websocket-client-simple/blob/master/CHANGELOG.md
 post_install_message: The development of this gem has moved to https://github.com/ruby-jp/websocket-client-simple.
 rdoc_options: []
 require_paths:
@@ -151,15 +151,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Simple WebSocket Client for Ruby
 test_files:

data/History.txt

@@ -1,80 +0,0 @@
-=== 0.3.1 2021-12-30
-
-* The development of this repository has moved to https://github.com/ruby-jp/websocket-client-simple
-
-=== 0.3.0 2016-02-20
-
-* "connect" method runs a given block before connecting WebSocket  #12
-  * thank you for suggestion @codekitchen
-
-=== 0.2.5 2016-02-18
-
-* bugfixed sending when broken pipe  #15
-* add :verify_mode option for SSL Context  #14
-  * thank you for contributing @michaelvilensky
-
-=== 0.2.4 2015-11-12
-
-* support handshake headers  #11
-  * thank you for contributing @mathieugagne
-
-=== 0.2.3 2015-10-26
-
-* kill thread at end of method
-  * thank you for contributing @hansy
-
-=== 0.2.2 2014-11-18
-
-* add :ssl_version option to specify version of SSL/TLS
-  * thank you for contributing @tonybyrne
-
-=== 0.2.1 2014-10-19
-
-* bugfix socket reading
-
-=== 0.2.0 2014-06-07
-
-* SSL support with wss:// and https:// scheme
-  * thank you for contributing @mallowlabs
-
-=== 0.1.0 2014-05-08
-
-* add accessor Client#handshake  #5
-* bugfix socket reading
-
-=== 0.0.9 2014-04-03
-
-* emit "error" in receive thread
-* rescue only Errno::EPIPE, not all Errors
-
-=== 0.0.8 2014-01-29
-
-* bugfix Client#close  #4
-
-=== 0.0.7 2014-01-29
-
-* send CLOSE frame in Client#close  #4
-
-=== 0.0.6 2014-01-17
-
-* add function Client#open?
-
-=== 0.0.5 2013-03-23
-
-* kill read thread on close
-
-=== 0.0.4 2013-03-23
-
-* fix sample and README
-
-=== 0.0.3 2013-03-23
-
-* :type => :text option in send
-
-=== 0.0.2 2013-03-22
-
-* remove unnecessary sleep
-
-=== 0.0.1 2013-03-22
-
-* release