wands 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed955880d15ca35b40902f4be003d4615c049b113f7408873a64a0553a1a9e78
+  data.tar.gz: da44bcd5f0c393bf14ff2c55d16acd1eef21ac2073ad60f3e58b5d267fbc4db7
+SHA512:
+  metadata.gz: e75f52070180a29dee8a4d2a0dbfa0d7bf077cf09d917948610f6db0c06b4be21c5ad3a91adb62f5d2992746488e08580d0e9780e09d7d528dc4b111055ba35d
+  data.tar.gz: c2dcf0cc618b07e62f79f5113c4596b848a77122cb97e60457bebf108404122898261a7610de4fc0c119c3aa629c9705a630f4fc17d2d6308be98d625de4041c

data/.idea/.gitignore

@@ -0,0 +1,3 @@
+# Default ignored files
+/shelf/
+/workspace.xml

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="rbenv: 3.3.5" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/wands.iml" filepath="$PROJECT_DIR$/.idea/wands.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

data/.idea/wands.iml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="fiber-annotation (v0.2.0, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="fiber-local (v1.1.0, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="fiber-storage (v1.0.0, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="language_server-protocol (v3.17.0.3, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="protocol-websocket (v0.20.1, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="racc (v1.8.1, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.2.1, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="stringio (v3.1.2, rbenv: 3.3.5) [gem]" level="application" />
+  </component>
+</module>

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Exclude:
+    - wands.gemspec
+
+require:
+  - rubocop-minitest
+  - rubocop-rake

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 shigeru.nakajima
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Wands
+
+A low-level WebSocket library compatible with Ruby's TCPSocket.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add wands
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install wands
+```
+
+## Usage
+
+### Server
+
+```ruby
+server = Wands::WebSocketServer.open('localhost', 2345)
+
+loop do
+  client = server.accept
+  client.write("Hello World!")
+  client.close
+end
+```
+
+### Client
+
+```ruby
+web_socket = Wands::WebSocket.open('localhost', 2345)
+web_socket.write("Hello World!")
+puts web_socket.gets
+web_socket.close
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ledsun/wands.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/wands/http_response.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Wands
+  # This is a class that parses the response from the server and stores the headers in a hash.
+  # The parse and header methods in this class are modeled on WEBrick::HTTPRequest.
+  #
+  # The expected HTTP response string is:
+  #
+  # HTTP/1.1 101 Switching Protocols
+  # Upgrade: websocket
+  # Connection: Upgrade
+  # Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=
+  # Sec-WebSocket-Protocol: chat
+  # Sec-WebSocket-Version: 13
+  #
+
+  # Example usage:
+  #
+  # response = HTTPResponse.new
+  # response.parse(socket)
+  # response.header["upgrade"] # => ["websocket"]
+  # response.header["connection"] # => ["Upgrade"]
+  # response.header["sec-websocket-accept"] # => ["s3pPLMBiTxaQ9kYGzzhZRbK+xOo="]
+  #
+  class HTTPResponse
+    attr_reader :status, :header
+
+    def parse(stream)
+      @response = read_from stream
+      @status, @header = headers_of @response
+    end
+
+    def to_s
+      @response
+    end
+
+    private
+
+    def read_from(stream)
+      response_string = ""
+      while (line = stream.gets) != "\r\n"
+        response_string += line
+      end
+
+      response_string
+    end
+
+    # Parse the headers from the HTTP response string.
+    def headers_of(response_string)
+      # Split the response string into headers and body.
+      headers, _body = response_string.split("\r\n\r\n", 2)
+
+      # Split the headers into lines.
+      headers_lines = headers.split("\r\n")
+
+      # The first line is the status line.
+      # We don't need it, so we remove it from the headers.
+      status_line = headers_lines.shift
+      status_code = status_line.split[1]
+
+      # Parse the headers into a hash.
+      headers = headers_lines.to_h do |line|
+        # Split the line into header name and value.
+        header_name, value = line.split(": ", 2)
+        [header_name.downcase, [value.strip]]
+      end
+
+      [status_code, headers]
+    end
+  end
+end

data/lib/wands/response_exception.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Wands
+  # This exception is raised when the response from the server is not as expected.
+  class ResponseException < StandardError
+    attr_reader :response
+
+    def initialize(message, response)
+      super(message)
+      @response = response
+    end
+
+    def to_s
+      "#{super} from '#{response}'"
+    end
+  end
+end

data/lib/wands/upgrade_request.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "erb"
+require "protocol/websocket/headers"
+require_relative "response_exception"
+
+module Wands
+  # The request is used to upgrade the HTTP connection to a WebSocket connection.
+  class UpgradeRequest
+    include ::Protocol::WebSocket::Headers
+
+    # The Host header is required in HTTP 1.1.
+    TEMPLATE = <<~REQUEST
+      GET / HTTP/1.1
+      Host: <%= @host %>:<%= @port %>
+      Connection: Upgrade
+      Upgrade: websocket
+      Sec-WebSocket-Version: 13
+      Sec-WebSocket-Key: <%= @key %>
+
+    REQUEST
+
+    ERB = ERB.new(TEMPLATE).freeze
+
+    def initialize(host, port)
+      @host = host
+      @port = port
+      @key = Nounce.generate_key
+    end
+
+    def to_s
+      ERB.result(binding).gsub(/\r?\n/, "\r\n")
+    end
+
+    def verify(response)
+      accept_digest = response.header[SEC_WEBSOCKET_ACCEPT].first
+      accept_digest == Nounce.accept_digest(@key) || raise(ResponseException.new("Invalid accept digest", response))
+    end
+  end
+end

data/lib/wands/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Wands
+  VERSION = "0.1.0"
+end

data/lib/wands/web_socket.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "socket"
+require "forwardable"
+require "protocol/websocket/headers"
+require "protocol/websocket/framer"
+require "protocol/websocket/text_frame"
+require_relative "upgrade_request"
+require_relative "http_response"
+require_relative "response_exception"
+
+module Wands
+  # This is a class that represents WebSocket, which has the same interface as TCPSocket.
+  #
+  # The WebSocket class is responsible for reading and writing messages to the server.
+  #
+  # Example usage:
+  #
+  # web_socket = WebSocket.open('localhost', 2345)
+  # web_socket.write("Hello World!")
+  #
+  # puts web_socket.gets
+  #
+  # web_socket.close
+  #
+  class WebSocket
+    include Protocol::WebSocket::Headers
+    extend Forwardable
+
+    def_delegators :@socket, :addr, :remote_address, :close, :to_io
+
+    def self.open(host, port)
+      socket = TCPSocket.new(host, port)
+      request = UpgradeRequest.new(host, port)
+      socket.write(request.to_s)
+      socket.flush
+
+      response = HTTPResponse.new
+      response.parse(socket)
+      raise ResponseException.new("Bad Status", response) unless response.status == "101"
+
+      request.verify response
+
+      new(socket)
+    end
+
+    def initialize(socket)
+      @socket = socket
+    end
+
+    # @return [String]
+    def gets
+      framer = Protocol::WebSocket::Framer.new(@socket)
+      frame = framer.read_frame
+      raise "frame is not a text" unless frame.is_a? Protocol::WebSocket::TextFrame
+
+      frame.unpack
+    end
+
+    def write(message)
+      frame = Protocol::WebSocket::TextFrame.new(true, message)
+      frame.write(@socket)
+    end
+  end
+end

data/lib/wands/web_socket_server.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "socket"
+require "protocol/websocket/headers"
+require "webrick/httprequest"
+require "webrick/httpresponse"
+require "webrick/config"
+require_relative "web_socket"
+
+module Wands
+  # The WebSocketServer class is responsible for accepting WebSocket connections.
+  # This class has the same interface as TCPServer.
+  #
+  # Example usage:
+  #
+  # server = WebSocketServer.new('localhost', 2345)
+  # loop do
+  #  begin
+  #   socket = server.accept
+  #   next unless socket
+  #   puts "Accepted connection from #{socket.remote_address.ip_address} #{socket.remote_address.ip_port}"
+  #
+  #   received_message = socket.gets
+  #   puts "Received: #{received_message}"
+  #
+  #   socket.write received_message
+  #   socket.close
+  #  rescue WEBrick::HTTPStatus::EOFError => e
+  #   STDERR.puts e.message
+  #  rescue Errno::ECONNRESET => e
+  #   STDERR.puts "#{e.message} #{socket.remote_address.ip_address} #{socket.remote_address.ip_port}"
+  #  rescue EOFError => e
+  #   STDERR.puts "#{e.message} #{socket.remote_address.ip_address} #{socket.remote_address.ip_port}"
+  #  end
+  # end
+  #
+  class WebSocketServer
+    include Protocol::WebSocket::Headers
+
+    def self.open(hostname, port)
+      new(hostname, port)
+    end
+
+    def initialize(hostname, port)
+      @tcp_server = TCPServer.new hostname, port
+    end
+
+    def accept
+      socket = @tcp_server.accept
+
+      request = WEBrick::HTTPRequest.new(WEBrick::Config::HTTP)
+      headers = read_headers_from request, socket
+      unless headers["upgrade"].include? PROTOCOL
+        socket.close
+        raise "Not a websocket request"
+      end
+
+      response = response_to headers
+      response.send_response socket
+
+      WebSocket.new socket
+    rescue WEBrick::HTTPStatus::BadRequest => e
+      warn "WEBRick error message: #{e.full_message}"
+      warn "HTTP request string: #{request}" if request
+      if socket
+        socket.write "HTTP/1.1 400 Bad Request\r\n\r\n"
+        socket.close
+      end
+    end
+
+    private
+
+    def read_headers_from(request, socket)
+      request.parse(socket)
+      request.header
+    end
+
+    def response_to(headers)
+      response_key = calculate_accept_nonce_from headers
+      response = WEBrick::HTTPResponse.new(WEBrick::Config::HTTP)
+      response.status = 101
+      response.upgrade! PROTOCOL
+      response[SEC_WEBSOCKET_ACCEPT] = response_key
+
+      response
+    end
+
+    def calculate_accept_nonce_from(headers)
+      key = headers[SEC_WEBSOCKET_KEY].first
+      Nounce.accept_digest(key)
+    end
+  end
+end

data/lib/wands.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "wands/version"
+require_relative "wands/web_socket"
+require_relative "wands/web_socket_server"

data/sig/wands.rbs

@@ -0,0 +1,30 @@
+module Wands
+  VERSION: String
+
+  class WebSocket
+    @socket: TCPSocket
+
+    def initialize: (TCPSocket) -> void
+    def gets: () -> String
+    def write: (String) -> void
+    def self.open: (String, Integer) -> WebSocket
+    def close: () -> void
+    def addr: () -> Addrinfo
+    def remote_address: () -> Addrinfo
+  end
+
+  class WebSocketServer
+    @tcp_server: TCPServer
+
+    def initialize: (String, Integer) -> void
+    def self.open: (String, Integer) -> WebSocketServer
+    def accept: () -> WebSocket
+    def close: () -> void
+
+    private
+
+    def calculate_accept_nonce_from: (Hash[String, Array[String]]?) -> String
+    def read_headers_from: (WEBrick::HTTPRequest, TCPSocket) -> Hash[String, Array[String]]?
+    def response_to: (Hash[String, Array[String]]?) -> WEBrick::HTTPResponse
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: wands
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- shigeru.nakajima
+bindir: exe
+cert_chain: []
+date: 2024-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: protocol-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: A WebSocket library with the same layer as Ruby's TCPSocket, which does
+  not have the function of an HTTP server, in order to use WebSocket as a new protocol
+  for dRuby.
+email:
+- shigeru.nakajima@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".idea/wands.iml"
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- Rakefile
+- lib/wands.rb
+- lib/wands/http_response.rb
+- lib/wands/response_exception.rb
+- lib/wands/upgrade_request.rb
+- lib/wands/version.rb
+- lib/wands/web_socket.rb
+- lib/wands/web_socket_server.rb
+- sig/wands.rbs
+homepage: https://github.com/ledsun/wands
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ledsun/wands
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A low-level WebSocket library compatible with Ruby's TCPSocket.
+test_files: []