websocket-client-simple 0.2.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 623aead32607d8c834bc65df09362499318de0d2
-  data.tar.gz: 253e82d0aa89a3824f54a7b1847aa07bb5ca2510
+SHA256:
+  metadata.gz: 7d666b814dc1c12018495f1eb3e5810ff95ac854cb2e6b67e8932d6d9e2734be
+  data.tar.gz: dc8803a68f0a83dca8cc7768669294b98329fc425caa6e29329fb5aed1221670
 SHA512:
-  metadata.gz: 75f6f89f7bffe9451a9a9c2bdfe1fd32d7b126e6d34e92c47d6cfebb66a31b62c26d4cebbb9e8e8b7df2213f165daf0ef3831bdc768bb7215ed5914997e4e404
-  data.tar.gz: 10deab6207a36de46133049bfa14f619caedb53d6f475294bd5196c6403d7eb0c458afe3fb42315758597430ea02d9fff0752166ccb6b934131e70d079683725
+  metadata.gz: b9cd01826ba0e697dfd029422491317f25d4946688fc1ad3764d7d5c1976f0913ed030839213a04772099882989a0c324700320ef409e31770ae9a63c2870431
+  data.tar.gz: 4ce1ef9d1ebc4a67f373c527e151ece73717f8e782fca31b09dd77baa242c3e93ccf4d5918e7c23381671adceeb69075b4987f5a5e5336f358000692bb0b09c9

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+on:
+  push:
+    branches:
+      - "*"
+  pull_request:
+    branches:
+      - "*"
+  schedule:
+    - cron: "0 0 * * 6" # At 00:00 on Saturday
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        ruby: ["3.1", "3.0", "2.7", "2.6"]
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.gitignore

@@ -14,3 +14,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Gemfile.lock
+.ruby-version

data/History.txt

@@ -1,6 +1,26 @@
+=== 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-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
+* support handshake headers  #11
+  * thank you for contributing @mathieugagne
 
 === 0.2.3 2015-10-26
 

data/README.md

@@ -1,12 +1,11 @@
 websocket-client-simple
 =======================
-Simple WebSocket Client for Ruby
+Simple WebSocket Client for Ruby (original author: @shokai)
 
-- https://github.com/shokai/websocket-client-simple
+- https://github.com/ruby-jp/websocket-client-simple
 - https://rubygems.org/gems/websocket-client-simple
 
-[![Build Status](https://travis-ci.org/shokai/websocket-client-simple.png?branch=master)](https://travis-ci.org/shokai/websocket-client-simple)
-
+[![.github/workflows/test.yml](https://github.com/ruby-jp/websocket-client-simple/actions/workflows/test.yml/badge.svg)](https://github.com/ruby-jp/websocket-client-simple/actions/workflows/test.yml)
 
 Installation
 ------------
@@ -44,6 +43,20 @@ loop do
 end
 ```
 
+`connect` runs a given block before connecting websocket
+
+```ruby
+WebSocket::Client::Simple.connect 'ws://example.com:8888' do |ws|
+  ws.on :open do
+    puts "connect!"
+  end
+
+  ws.on :message do |msg|
+    puts msg.data
+  end
+end
+```
+
 
 Sample
 ------

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

@@ -3,14 +3,18 @@ module WebSocket
     module Simple
 
       def self.connect(url, options={})
-        ::WebSocket::Client::Simple::Client.new(url, options)
+        client = ::WebSocket::Client::Simple::Client.new
+        yield client if block_given?
+        client.connect url, options
+        return client
       end
 
       class Client
         include EventEmitter
         attr_reader :url, :handshake
 
-        def initialize(url, options={})
+        def connect(url, options={})
+          return if @socket
           @url = url
           uri = URI.parse url
           @socket = TCPSocket.new(uri.host,
@@ -18,11 +22,16 @@ module WebSocket
           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
+            cert_store.set_default_paths
+            ctx.cert_store = cert_store
             @socket = ::OpenSSL::SSL::SSLSocket.new(@socket, ctx)
             @socket.connect
           end
           @handshake = ::WebSocket::Handshake::Client.new :url => url, :headers => options[:headers]
           @handshaked = false
+          @pipe_broken = false
           frame = ::WebSocket::Frame::Incoming::Client.new
           @closed = false
           once :__close do |err|
@@ -65,13 +74,16 @@ module WebSocket
           begin
             @socket.write frame.to_s
           rescue Errno::EPIPE => e
+            @pipe_broken = true
             emit :__close, e
           end
         end
 
         def close
           return if @closed
-          send nil, :type => :close
+          if !@pipe_broken
+            send nil, :type => :close
+          end
           @closed = true
           @socket.close if @socket
           @socket = nil

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

@@ -1,7 +1,7 @@
 module WebSocket
   module Client
     module Simple
-      VERSION = "0.2.4"
+      VERSION = "0.4.0"
     end
   end
 end

data/test/echo_server.rb

@@ -0,0 +1,26 @@
+module EchoServer
+  def self.start
+    WebSocket::EventMachine::Server.start(:host => "0.0.0.0", :port => self.port) do |ws|
+      @channel = EM::Channel.new
+      ws.onopen do
+        sid = @channel.subscribe do |mes|
+          ws.send mes  # echo to client
+        end
+        ws.onmessage do |msg|
+          @channel.push msg
+        end
+        ws.onclose do
+          @channel.unsubscribe sid
+        end
+      end
+    end
+  end
+
+  def self.port
+    (ENV['WS_PORT'] || 18080).to_i
+  end
+
+  def self.url
+    "ws://localhost:#{self.port}"
+  end
+end

data/test/test_connect_block.rb

@@ -0,0 +1,33 @@
+require File.expand_path 'test_helper', File.dirname(__FILE__)
+
+class TestWebSocketClientSimple < MiniTest::Test
+  
+  def test_onopen
+    
+    EM::run{
+      
+      EchoServer.start
+
+      res = nil
+
+      EM::add_timer 1 do
+        WebSocket::Client::Simple.connect EchoServer.url do |client|
+          client.on :open do
+            client.send "hello world"
+          end
+
+          client.on :message do |msg|
+            res = msg.to_s
+          end
+        end
+      end
+
+      EM::add_timer 2 do
+        assert_equal res, "hello world"
+        EM::stop_event_loop
+      end
+    }
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -4,5 +4,6 @@ require 'minitest/autorun'
 require 'websocket-client-simple'
 require 'eventmachine'
 require 'websocket-eventmachine-server'
+require_relative 'echo_server'
 
 $:.unshift File.expand_path '../lib', File.dirname(__FILE__)

data/test/test_websocket_client_simple.rb

@@ -1,40 +1,20 @@
-require File.expand_path 'test_helper', File.dirname(__FILE__)
+require_relative 'test_helper'
 
 class TestWebSocketClientSimple < MiniTest::Test
 
-  def port
-    (ENV['WS_PORT'] || 18080).to_i
-  end
-
   def test_echo
     msgs = ['foo','bar','baz']
     res1 = []
     res2 = []
 
     EM::run{
-      @channel = EM::Channel.new
-
-      ## echo server
-      WebSocket::EventMachine::Server.start(:host => "0.0.0.0", :port => port) do |ws|
-        ws.onopen do
-          sid = @channel.subscribe do |mes|
-            ws.send mes
-          end
-          ws.onmessage do |msg|
-            @channel.push msg
-          end
-          ws.onclose do
-            @channel.unsubscribe sid
-          end
-        end
-      end
+      EchoServer.start
 
       ## client1 --> server --> client2
       EM::add_timer 1 do
-        url = "ws://localhost:#{port}"
-        client1 = WebSocket::Client::Simple.connect url
+        client1 = WebSocket::Client::Simple.connect EchoServer.url
+        client2 = WebSocket::Client::Simple.connect EchoServer.url
         assert_equal client1.open?, false
-        client2 = WebSocket::Client::Simple.connect url
         assert_equal client2.open?, false
 
         client1.on :message do |msg|

data/websocket-client-simple.gemspec

@@ -5,19 +5,28 @@ require 'websocket-client-simple/version'
 Gem::Specification.new do |spec|
   spec.name          = "websocket-client-simple"
   spec.version       = WebSocket::Client::Simple::VERSION
-  spec.authors       = ["Sho Hashimoto"]
-  spec.email         = ["hashimoto@shokai.org"]
+  spec.authors       = ["Sho Hashimoto", "Yusuke Nakamura"]
+  spec.email         = ["hashimoto@shokai.org", "yusuke1994525@gmail.com"]
   spec.description   = %q{Simple WebSocket Client for Ruby}
   spec.summary       = spec.description
-  spec.homepage      = "https://github.com/shokai/websocket-client-simple"
+  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"
+  end
+
+  spec.post_install_message = "The development of this gem has moved to #{spec.homepage}."
 
   spec.files         = `git ls-files`.split($/).reject{|f| f == "Gemfile.lock" }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "websocket-eventmachine-server"

metadata

@@ -1,29 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: websocket-client-simple
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Sho Hashimoto
+- Yusuke Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2021-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -111,12 +112,13 @@ dependencies:
 description: Simple WebSocket Client for Ruby
 email:
 - hashimoto@shokai.org
+- yusuke1994525@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - History.txt
 - LICENSE.txt
@@ -129,14 +131,19 @@ files:
 - sample/echo_server.rb
 - sample/webbrowser/index.html
 - sample/webbrowser/main.js
+- test/echo_server.rb
+- test/test_connect_block.rb
 - test/test_helper.rb
 - test/test_websocket_client_simple.rb
 - websocket-client-simple.gemspec
-homepage: https://github.com/shokai/websocket-client-simple
+homepage: https://github.com/ruby-jp/websocket-client-simple
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+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
+post_install_message: The development of this gem has moved to https://github.com/ruby-jp/websocket-client-simple.
 rdoc_options: []
 require_paths:
 - lib
@@ -144,18 +151,19 @@ 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: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Simple WebSocket Client for Ruby
 test_files:
+- test/echo_server.rb
+- test/test_connect_block.rb
 - test/test_helper.rb
 - test/test_websocket_client_simple.rb

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - '2.1.2'
-notifications:
-  slack:
-    secure: avBo0DyucPM8qK2F2qNT5yirZJNcXWfY9d4QKxZLfOa4aQZJ6y/x78Guo8fki/8ZLNnud+rsty3/QkPxBi3YUWcyIuCXMEcuYc8BWOjL+oD37DPgJxGg6ANKxuMotZMUzZweplkd/KgafugOHr7fsPt5UwX2ZYrZr+ksuemEoxs=