ws_lite 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a4d467537dc76203fecc8772535bff50177558679bfdf486ebddd0377527cbe
-  data.tar.gz: e07a6f57ca1fb0fb65b14e0f6be4afcb51d6f6e0c58c95c616bf8e150762e541
+  metadata.gz: e92d3ead4261b5f4c8f3ea9e9bf97c3f5656ee22661acd4263802bfad5926e73
+  data.tar.gz: 29fab93562e216ffc5ef86221dcba0befed7788ca434bc71268ccf288c1e7413
 SHA512:
-  metadata.gz: cc3b14af80f5d887ef4fece93825388640e8966fc1e1c36f02a4a9694f87d3186b9e0525d4eee5fd7301762c0192d2f73fa3f6ca6e8ac76c5c1c0c9a25471411
-  data.tar.gz: 26fe3e76666de59d5a671e2f26641409c752d9c90aced70e4b17b623502a748ef071cb71f49ffe1c4e7b6d8b260251d5834aecdade9518090a2ddf08e28f0dd5
+  metadata.gz: 6f132c4f4ea9ac91ff35b9868b98d884a19ab5d47407a6d38bcf4e72bbdf3347786aefe1b37082d0a818ea8580188b73e5dc522dbc154c1701851484796d1cd4
+  data.tar.gz: 10e6ce3c6cf7aed308ade1d5f946c9766234022b619c6ebab170977f15b8d704548dba555bfca763b30d7483b0fd099fce404e179db8d9bdcb1fa3a7f7691d34

data/.github/workflows/test.yml

@@ -14,7 +14,9 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - '3.4.3'
+          - '3.3'
+          - '3.4'
+          - '4.0'
 
     steps:
       - uses: actions/checkout@v4

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.4
+  TargetRubyVersion: 3.3
   NewCops: enable
   SuggestExtensions: false
   Exclude:

data/AGENTS.md

@@ -0,0 +1,48 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+ws_lite is a lightweight WebSocket client library for Ruby (successor to websocket-client-simple). It provides an event-driven API for connecting to WebSocket servers with support for secure connections (WSS) and custom SSL options. Requires Ruby >= 3.3.0.
+
+## Commands
+
+```bash
+bundle install              # Install dependencies
+bundle exec rake            # Run tests and linting (default task)
+bundle exec rake test       # Run tests only
+bundle exec rake rubocop    # Run linting only
+```
+
+## Architecture
+
+The library uses an event-driven pattern built on the `event_emitter` gem:
+
+- **Entry point**: `lib/ws_lite.rb` - Module-level `connect` method creates Client instances
+- **Core implementation**: `lib/ws_lite/client.rb` - Contains all WebSocket logic
+
+**Connection flow**:
+1. `WSLite.connect(url, options)` creates a new `WSLite::Client`
+2. Client parses URL and opens TCP socket
+3. For `wss://`, wraps socket with SSL (OpenSSL 3.x compatible)
+4. Performs WebSocket handshake
+5. Spawns reader thread that loops on `socket.getc`, emitting events:
+   - `:open` - Connection established
+   - `:message` - Frame received (data in `event.data`)
+   - `:close` - Connection closed
+   - `:error` - Error occurred
+
+**Key methods**: `send(data, opt)`, `close()`, `open?`, `closed?`
+
+## Testing
+
+Tests use Minitest with an EventMachine-based echo server (`test/echo_server.rb`). Run individual tests with:
+
+```bash
+ruby -Ilib:test test/test_websocket_client_simple.rb
+```
+
+## Code Style
+
+RuboCop configured for Ruby 3.3+ with 120-character line limit. The client.rb file has relaxed method length/complexity metrics due to inherent WebSocket protocol complexity.

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.1
+
+* Support Ruby 3.3.x through 4.0.x
+
 ## 1.0.0
 
 * Update metadata

data/CLAUDE.md

@@ -0,0 +1,6 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+AGENTS.md is the canonical source of truth; this file exists only as a Claude Code convenience entrypoint.
+For comprehensive architecture documentation and implementation details, see **[AGENTS.md](./AGENTS.md)**.

data/README.md

@@ -1,18 +1,29 @@
-ws_lite
-=======
+# ws_lite
+
 [![Gem Version](https://badge.fury.io/rb/ws_lite.svg)](https://rubygems.org/gems/ws_lite)
 [![Downloads](https://img.shields.io/gem/dt/ws_lite.svg)](https://rubygems.org/gems/ws_lite)
 [![CI](https://github.com/carter2099/ws_lite/actions/workflows/test.yml/badge.svg)](https://github.com/carter2099/ws_lite/actions)
 
 Successor to [websocket-client-simple](https://github.com/ruby-jp/websocket-client-simple) with OpenSSL 3.x fixes and improved connection reliability.
 
-Installation
-------------
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ws_lite'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
 
-    gem install ws_lite
+    $ gem install ws_lite
+
+## Usage
 
-Usage
------
 ```ruby
 require 'ws_lite'
 
@@ -67,25 +78,15 @@ ws = WSLite.connect 'wss://example.com', ssl_context: ctx
 
 By default, `OP_IGNORE_UNEXPECTED_EOF` is enabled on OpenSSL 3.x to prevent `SSL_read: unexpected eof while reading` errors when servers close connections without a TLS `close_notify` alert.
 
+## Development
 
-Sample
-------
-[websocket chat](https://github.com/carter2099/ws_lite/tree/master/sample)
-
+    $ bundle install
+    $ rake
 
-Test
-----
+## Contributing
 
-    % gem install bundler
-    % bundle install
-    % export WS_PORT=8888
-    % rake test
+Bug reports and pull requests are welcome on GitHub at https://github.com/carter2099/ws_lite.
 
+## License
 
-Contributing
-------------
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/ws_lite/version.rb

@@ -1,3 +1,3 @@
 module WSLite
-  VERSION = "1.0.0".freeze
+  VERSION = "1.0.1".freeze
 end

data/ws_lite.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/carter2099/ws_lite"
   spec.license       = "MIT"
-  spec.required_ruby_version = '>= 3.4.0'
+  spec.required_ruby_version = '>= 3.3.0'
 
   if spec.respond_to?(:metadata)
     spec.metadata["homepage_uri"] = spec.homepage

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ws_lite
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - carter2099
@@ -146,7 +146,9 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- AGENTS.md
 - CHANGELOG.md
+- CLAUDE.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -154,10 +156,6 @@ files:
 - lib/ws_lite.rb
 - lib/ws_lite/client.rb
 - lib/ws_lite/version.rb
-- sample/client.rb
-- 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
@@ -178,14 +176,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.4.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A lightweight and configurable ruby websocket client
 test_files: []

data/sample/client.rb

@@ -1,30 +0,0 @@
-#!/usr/bin/env ruby
-$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
-require 'ws_lite'
-
-puts "ws_lite v#{WSLite::VERSION}"
-
-url = ARGV.shift || 'ws://localhost:8080'
-
-ws = WSLite.connect url
-
-ws.on :message do |msg|
-  puts ">> #{msg.data}"
-end
-
-ws.on :open do
-  puts "-- websocket open (#{ws.url})"
-end
-
-ws.on :close do |e|
-  puts "-- websocket close (#{e.inspect})"
-  exit 1
-end
-
-ws.on :error do |e|
-  puts "-- error (#{e.inspect})"
-end
-
-loop do
-  ws.send STDIN.gets.strip
-end

data/sample/echo_server.rb

@@ -1,34 +0,0 @@
-#!/usr/bin/env ruby
-require 'eventmachine'
-require 'websocket-eventmachine-server'
-
-PORT = (ARGV.shift || 8080).to_i
-
-EM::run do
-  @channel = EM::Channel.new
-
-  puts "start websocket server - port:#{PORT}"
-
-  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
-      puts "<#{sid}> connect"
-
-      @channel.push "hello new client <#{sid}>"
-
-      ws.onmessage do |msg|
-        puts "<#{sid}> #{msg}"
-        @channel.push "<#{sid}> #{msg}"
-      end
-
-      ws.onclose do
-        puts "<#{sid}> disconnected"
-        @channel.unsubscribe sid
-        @channel.push "<#{sid}> disconnected"
-      end
-    end
-  end
-
-end

data/sample/webbrowser/index.html

@@ -1,22 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="UTF-8" content="text/html" http-equiv="Content-Type">
-    <title>websocket chat</title>
-    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
-    <script src="./main.js"></script>
-  </head>
-  <body>
-    <h1>websocket chat</h1>
-    <div>
-      <input id="name" size="15" type="text" value="NAME">
-      <input id="message" size="80" type="text" value="hello hello">
-      <input id="btn_post" type="button" value="post">
-    </div>
-    <ul id="chat"></ul>
-    <div id="footer">
-      <hr>
-      <a href="https://github.com/carter2099/ws_lite">https://github.com/carter2099/ws_lite</a>
-    </div>
-  </body>
-</html>

data/sample/webbrowser/main.js

@@ -1,38 +0,0 @@
-var ws = new WebSocket("ws://localhost:8080");
-
-ws.onmessage = function(e){
-  print(e.data);
-};
-
-ws.onopen = function(e){
-  log("websocket open");
-  console.log(e);
-};
-
-ws.onclose = function(e){
-  log("websocket close");
-  console.log(e);
-};
-
-$(function(){
-  $("#btn_post").click(post);
-  $("#message").keydown(function(e){
-    if(e.keyCode == 13) post();
-  });
-});
-
-var post = function(){
-  var name = $("#name").val();
-  var mes = $("#message").val();
-  ws.send(name+" : "+mes);
-  $("input#message").val("");
-};
-
-var log = function(msg){
-  console.log(msg);
-  $("#chat").prepend($("<li>").text("[log] "+msg));
-};
-
-var print = function(msg){
-  $("#chat").prepend($("<li>").text(msg));
-};