websocket_client_lite 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57be41a22406e00807c3747e93f1621de3775fbc94d2c7e5f527e55a518a8677
+  data.tar.gz: 32f3e7db065169c8f3bf5a9e93856f12737599298941b9109a0540a1a4b3a636
+SHA512:
+  metadata.gz: a22713d01e0191bd2531b9c1e9b2807f7447ef1da7e49f6004f13f573fa6e8db3c1dae219f22ea50593537b64fe96c98ad2260d1a23eec98c479d5042f13fdb1
+  data.tar.gz: 71b753100eed4e7d3b05429bf6433f8e201ca3b3acf81d94b556693c88d9b53cef51c306b643073da746d6a49fdbfd68a7272304147ca6d5d67100a4fe000dcb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 30
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-03-27
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in websocket_client_lite.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    websocket_client_lite (0.1.0)
+      websocket
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+    websocket (1.2.9)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-darwin-22
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  websocket_client_lite!
+
+BUNDLED WITH
+   2.4.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Ueda Satoshi
+
+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 @@
+# WebsocketClientLite
+
+Easy to use WebSocket client for Ruby.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```sh
+$ bundle add websocket_client_lite
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```sh
+$ gem install websocket_client_lite
+```
+
+## Usage
+
+```ruby
+require 'websocket_client_lite'
+
+url = 'wss://echo.websocket.org/'
+logger = Logger.new($stdout)
+client = WebsocketClientLite.new(url, logger: logger)
+return unless client.handshake
+
+client.send_text('hello')
+client.each_payload do |payload|
+  puts payload
+  client.close
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` 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/gunyoki/websocket_client_lite.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/websocket_client_lite/version.rb

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

data/lib/websocket_client_lite.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require "logger"
+require "openssl"
+require "socket"
+require "websocket"
+require_relative "websocket_client_lite/version"
+
+class WebsocketClientLite
+  attr_accessor :url, :logger, :incoming_queue, :handshake_object, :socket, :state
+
+  def initialize(url, logger: nil)
+    @url = url
+    @logger = logger || Logger.new(File::NULL)
+    @incoming_queue = Queue.new
+    @state = nil
+  end
+
+  def handshake
+    @state = :connecting
+    @handshake_object = WebSocket::Handshake::Client.new(url: @url)
+    @socket = make_socket(@handshake_object.host, @handshake_object.port, @handshake_object.secure)
+    @socket.write(@handshake_object.to_s)
+
+    until @handshake_object.finished?
+      byte = @socket.read(1)
+      @handshake_object << byte
+    end
+
+    @handshake_object.valid?
+    @state = :open
+    true
+  rescue StandardError => e
+    @logger.error("Handshake failed: #{e.inspect}")
+    @socket&.close
+    @socket = nil
+    @state = nil
+    false
+  end
+
+  def each_payload(&block)
+    thread = nil
+    return unless @state == :open
+
+    thread = start_incoming_thread
+
+    while %i[open closing_by_client].include?(@state) do
+      frame = @incoming_queue.pop
+      case frame.type
+      when :ping
+        send_pong(frame.data)
+      when :pong
+        # no-op
+      when :text, :binary
+        block.yield(frame.data)
+      when :close
+        if @state == :open
+          @state = :closing_by_server
+          send_close(frame.data)
+        end
+        @state = :closed
+      else
+        raise "Unknown frame. type: #{frame.type}, data: #{frame.data}"
+      end
+    end
+  ensure
+    thread&.join(1)
+    @socket&.close
+    @socket = nil
+    @state = nil
+  end
+
+  def close(code = nil, data = nil)
+    if @state == :open
+      @state = :closing_by_client
+      send_frame(:close, data, code: code)
+    end
+  end
+
+  def send_ping(code, data)
+    send_frame(:ping, data, code: code)
+  end
+
+  def send_pong(data)
+    send_frame(:pong, data)
+  end
+
+  def send_close(code)
+    send_frame(:close, nil, code: code)
+  end
+
+  def send_text(data)
+    send_frame(:text, data)
+  end
+
+  def send_binary(data)
+    send_frame(:binary, data)
+  end
+
+  private
+
+  def make_socket(host, port, secure)
+    socket = Socket.tcp(host, port)
+    socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+    if secure
+      socket = OpenSSL::SSL::SSLSocket.new(socket)
+      socket.connect
+      socket.post_connection_check(host)
+      socket.sync_close = true
+    end
+    socket
+  end
+
+  def start_incoming_thread
+    Thread.start(@socket, @incoming_queue, @logger) do |socket, incoming_queue, logger|
+      frame_processor = WebSocket::Frame::Incoming::Client.new
+      until socket.closed?
+        binary = socket.readpartial(4096)
+        frame_processor << binary
+        while (frame = frame_processor.next)
+          logger.debug("[ws incoming] type: #{frame.type}, code: #{frame.code}, data: #{frame.data}")
+          incoming_queue << frame
+        end
+      end
+    rescue StandardError => e
+      logger.error("[ws incoming] #{e.inspect}")
+    end
+  end
+
+  def send_frame(type, data, code: nil)
+    logger.debug("[ws outgoing] type: #{type}, code: #{code}, data: #{data}")
+    frame = WebSocket::Frame::Outgoing::Client.new(data: data, type: type, code: code, version: @handshake_object.version)
+    @socket.write(frame.to_s)
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: websocket_client_lite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ueda Satoshi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It works as a WebSocket client by simply implementing a block that handles
+  messages.
+email:
+- gunyoki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/websocket_client_lite.rb
+- lib/websocket_client_lite/version.rb
+homepage: https://rubygems.org/gems/websocket_client_lite
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/websocket_client_lite
+  source_code_uri: https://github.com/gunyoki/websocket_client_lite
+  changelog_uri: https://github.com/gunyoki/websocket_client_lite/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Easy to use WebSocket client
+test_files: []