catch-websocket-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53f1aa32e229515ee979769d54b7da55f048cd91d9c4675f0d28244fc67ef2df
+  data.tar.gz: 7705308c275bb4b98c32be0d29198169b64776d49a1e9a4965a455340ff2bff2
+SHA512:
+  metadata.gz: 77210f270f80d80d338bbf87549b216045e2a9c69910fe04f8fc0a11e83ecf728f91d9c626eaf28a530f9103df015e601b151538b1548bf16ff633083d8de2f9
+  data.tar.gz: c00d8fdadeb7b5413320b3329fa24ac32a10f811acbece1a47495a571ae8d002bcf3b1abebd1505c6d7143138cf83d7b79dc13c29538b52e965da1e6a1eece55

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -0,0 +1,57 @@
+catch-websocket-client
+======================
+This is a library for interactive WebSocket communication like HTTP.
+Once you send a request, it will keep waiting for a response.
+
+
+Usage
+-----
+## Case. 1
+```ruby
+require 'catch-websocket-client'
+
+cws = CatchWebSocket::Client.new 'wss://example.com'
+
+response = cws.request({
+  command: :auth,
+  params: {
+    id: 'username',
+    pw: 'password'
+  }
+})
+
+result = JSON.parse(response)
+
+puts JSON.pretty_generate(result)
+```
+
+
+## Case. 2
+```ruby
+require 'catch-websocket-client'
+
+result = nil
+CatchWebSocket::Client.open('wss://example.com') { |socket|
+  socket.request({
+  }) { |result|
+    result = JSON.parse(result)
+    if result['chunk']
+      results = []
+      while true
+        results[result['seq']] = result['chunk']
+        break if result['last']
+        result = JSON.parse(socket.receive)
+      end
+      result = JSON.parse(results.join)
+    end
+  }
+}
+
+puts JSON.pretty_generate(result)
+```
+
+## Copyright
+
+Copyright c 2022 @neirouter
+LICENSE: MIT License
+

data/catch-websocket-client.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'catch-websocket-client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'catch-websocket-client'
+  spec.version       = CatchWebSocket::VERSION
+  spec.authors       = ['nierouter']
+  spec.email         = ['nierouter@gmail.com']
+  spec.description   = 'This client sends a request and waits for a response, just like HTTP communication.'
+  spec.summary       = 'Catch WebSocket Client for Ruby'
+  spec.homepage      = 'https://github.com/nierouter/catch-websocket-client'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.7.5'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+  end
+
+  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_dependency 'json', '~> 2.6.1'
+  spec.add_dependency 'openssl', '~> 3.0.0'
+  spec.add_dependency 'timeout', '~> 0.2.0'
+  spec.add_dependency 'uri', '~> 0.11.0'
+  spec.add_dependency 'websocket', '~> 1.2.9'
+end

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

@@ -0,0 +1,85 @@
+module CatchWebSocket
+
+  # 
+  class Client
+    FrameTimeoutSec = 600
+    def self.open url, type=nil
+      client = CatchSocket.new url, type
+      if block_given?
+        begin
+          yield client
+        rescue => e
+          client.close
+          raise e
+        end
+        client.close
+        client = nil
+      end
+      return client
+    end
+
+    attr_reader :uri, :is_closed
+
+    def initialize url, type=nil
+      @uri = URI.parse url
+      @type = type || :text
+      ctx = OpenSSL::SSL::SSLContext.new
+      ctx.ssl_version = 'SSLv23'
+      ctx.options = OpenSSL::SSL::OP_NO_SSLv2
+      cert_store = OpenSSL::X509::Store.new
+      cert_store.set_default_paths
+      ctx.cert_store = cert_store
+      @socket = ::OpenSSL::SSL::SSLSocket.new(TCPSocket.new(@uri.host, @uri.port || 443), ctx)
+      @socket.connect
+      write_and_receive(@handshake = ::WebSocket::Handshake::Client.new(url: url))
+      @frame = ::WebSocket::Frame::Incoming::Client.new
+      @is_closed = false
+    end
+    def close
+      return if @is_closed
+      write_and_receive(nil, :close)
+      begin
+        @socket.close
+      rescue => e
+        raise e
+      end
+      @is_closed = true
+    end
+    def request message
+      unless @is_closed
+        message = JSON.generate(message) if message.is_a?(Hash) || message.is_a?(Array)
+        result = write_and_receive(message, @type)
+        if block_given?
+          yield result
+        else
+          return result
+        end
+      end
+    end
+    def write_and_receive message, type=nil
+      @last_message = message
+      message = ::WebSocket::Frame::Outgoing::Client.new(data: message, type: type, version: @handshake.version) if type
+      @socket.write message.to_s
+      receive
+    end
+    def receive
+      while true
+        character = nil
+        counter = 0
+        while (character = @socket.getc).nil?
+          sleep 0.1
+          counter += 1
+          raise Timeout::Error.new("FrameTimeout: #{@last_message}") if FrameTimeoutSec <= counter
+        end
+        if @frame.nil?
+          @handshake << character
+          return if @handshake.finished?
+        else
+          @frame << character
+          incoming = @frame.next
+          return incoming.data if incoming
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module CatchWebSocket
+  VERSION = '0.0.1'
+end

data/lib/catch-websocket-client.rb

@@ -0,0 +1,11 @@
+require 'json'
+require 'openssl'
+require 'timeout'
+require 'uri'
+require 'websocket'
+
+require 'catch-websocket-client/version'
+require 'catch-websocket-client/client'
+
+module CatchWebSocket
+end

data/test/sample.rb

@@ -0,0 +1,18 @@
+lib = 'lib'
+lib = File.expand_path((File.exist?(lib) ? '' : '../').concat(lib), __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'catch-websocket-client'
+
+cws = CatchWebSocket::Client.new 'wss://websocket.nierouter.com/'
+
+response = cws.request({
+  method: :auth,
+  params: {
+    user: 'nierouter',
+    pass: 'nierouter'
+  }
+})
+
+result = JSON.parse(response)
+
+puts JSON.pretty_generate(result)

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: catch-websocket-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- nierouter
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: timeout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.9
+description: This client sends a request and waits for a response, just like HTTP
+  communication.
+email:
+- nierouter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- catch-websocket-client.gemspec
+- lib/catch-websocket-client.rb
+- lib/catch-websocket-client/client.rb
+- lib/catch-websocket-client/version.rb
+- test/sample.rb
+homepage: https://github.com/nierouter/catch-websocket-client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nierouter/catch-websocket-client
+  source_code_uri: https://github.com/nierouter/catch-websocket-client
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Catch WebSocket Client for Ruby
+test_files:
+- test/sample.rb