weso 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a642dd75df8a5fb302d9b06fc0c5db537faa43a35173db5ac5d816fa2ad9540
+  data.tar.gz: 965a2b2c4d7d99954a1544a463c83e13dc4c78fe0ddc6c41abd304f896fca3e3
+SHA512:
+  metadata.gz: 0f450879a1d898d0f79b5837f6f063f8abfcdf0c00f2ccb83762c305cde2523c7f5c451d20c4286a7393de425dea2b67dc6ff115f78b6be0b9183444f689b022
+  data.tar.gz: 3caecb7e76ff24886e45bdc9443c0fd77de466495a59755abf8506582e93337a240db04dfb4f6e737d8104bb5ca187c8ce84aad5b48888bdccb938a3d6e5c1ec

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+  NewCops: enable

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at overchind@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in weso.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    weso (0.1.1)
+      event_emitter (~> 0.2.6)
+      openssl (~> 2.1.2)
+      uri (~> 0.10.0)
+      websocket (~> 1.2.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    event_emitter (0.2.6)
+    ipaddr (1.2.2)
+    openssl (2.1.2)
+      ipaddr
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (1.9.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+    uri (0.10.1)
+    websocket (1.2.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.9.0)
+  weso!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Roman Ovcharov
+
+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,75 @@
+# weso
+
+Ruby ***WE***b***SO***cket Client. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'weso'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+```bash
+gem install weso
+```
+
+## Usage
+
+You can create an instance of the `Weso::Base::Client` class and configure required events with a public `connect` method on the `Weso::Base` module. Note, that this method creates a new instance every time. The functionality with valid client reconnection now in progress.
+
+```ruby
+client = Weso::Base.connect 'wss://test.com' do |c|
+  c.on :open do
+    puts("I've opened a new websocket connection!")
+  end
+  
+  c.on :close do
+    puts("I'll miss you! Connection is closed now.")
+  end
+  
+  c.on :error do |error|
+    puts("I'm sorry, but something went wrong. Lets check the error:")
+    puts(error)
+  end
+end
+```
+
+If you need to configure encryption settings other than defaults, I advise you to review [`Weso::Base::SocketCreator`](./lib/weso/socket_creator.rb) class. In order to perform useful work with the client, you need to configure the `:message` event and not be shy to write first with `send_data` method:
+
+```ruby
+client.on :message do |message|
+  puts(message.data)
+end
+
+client.send_data("Hello! How you doing?")
+```
+
+In case if you want to check the client connection status - `open?`, `closed?` and `handshaked?` are your best friends. And do not forget to close the connection when you finished your work:
+
+```ruby
+client.close
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/overchind/weso. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/overchind/weso/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the weso project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/overchind/weso/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'weso'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/weso.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'event_emitter'
+require 'openssl'
+require 'socket'
+require 'uri'
+require 'websocket'
+
+require 'weso/base'
+require 'weso/version'
+
+module Weso
+  # ::nodoc::
+  module Base; end
+end

data/lib/weso/base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative './client'
+
+module Weso
+  # ::nodoc::
+  module Base
+    def self.connect(url, options = {})
+      client = Weso::Base::Client.new
+      yield client if block_given?
+      client.connect(url, options)
+    end
+  end
+end

data/lib/weso/client.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require_relative './socket_creator'
+
+module Weso
+  module Base
+    # ::nodoc::
+    class Client
+      include EventEmitter
+
+      def connect(url, options = {})
+        return if @socket
+
+        @socket = socket_creator(url, options).call
+        @closed = false
+
+        @handshake = handshake_client(url, options[:headers])
+        @handshaked = false
+
+        handshake
+        call_runner
+        self
+      end
+
+      def send_data(data, type: :text)
+        return unless open?
+
+        @socket.write_nonblock output_frame(data, type)
+        data
+      end
+
+      def handshake
+        @socket.write(@handshake.to_s)
+        process_socket(@socket, method(:handshaked?)) do |socket|
+          @handshake = read_socket(socket, @handshake)
+          @handshaked = @handshake.finished?
+        end
+      end
+
+      def close(error = nil)
+        return if closed?
+
+        emit :close, error
+      ensure
+        close_socket
+        close_runner
+      end
+
+      def open?
+        !closed? && handshaked?
+      end
+
+      def closed?
+        @closed
+      end
+
+      def handshaked?
+        @handshaked
+      end
+
+      private
+
+      def call_runner
+        @runner = Thread.new(@socket) do |socket|
+          emit :open
+          frame = input_frame
+
+          process_socket(socket, method(:closed?)) do |s|
+            frame = read_socket(s, frame)
+            frame = process_frame(frame)
+          end
+        end
+      end
+
+      def process_frame(frame)
+        if (msg = frame.next)
+          emit :message, msg
+          return input_frame
+        end
+
+        frame
+      end
+
+      def process_socket(socket, condition_method) # rubocop:disable Metrics/MethodLength
+        until condition_method.call
+          read_sockets, = IO.select([socket], nil, nil, 10) # TODO: Configured timeout?
+
+          next unless read_sockets && read_sockets[0]
+
+          begin
+            yield(socket)
+          rescue IO::WaitReadable
+            # Do nothing
+          rescue IO::WaitWritable
+            IO.select(nil, [socket])
+            retry
+          rescue EOFError => e
+            emit :error, e
+            close(e)
+          rescue StandardError => e
+            emit :error, e
+          end
+        end
+      end
+
+      def read_socket(socket, frame)
+        frame << socket.read_nonblock(1024)
+        frame << socket.read(socket.pending) while socket.respond_to?(:pending) && socket.pending.positive?
+        frame
+      end
+
+      def input_frame
+        ::WebSocket::Frame::Incoming::Client.new
+      end
+
+      def output_frame(data, type)
+        ::WebSocket::Frame::Outgoing::Client.new(data: data, type: type, version: @handshake.version).to_s
+      end
+
+      def socket_creator(url, options)
+        ::Weso::Base::SocketCreator.new(url, options)
+      end
+
+      def handshake_client(url, headers)
+        ::WebSocket::Handshake::Client.new(url: url, headers: headers)
+      end
+
+      def close_socket
+        @closed = true
+        @socket&.close
+        @socket = nil
+      end
+
+      def close_runner
+        Thread.kill @runner if @runner
+      end
+    end
+  end
+end

data/lib/weso/socket_creator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Weso
+  module Base
+    # ::nodoc::
+    class SocketCreator
+      attr_reader :uri, :options
+
+      DEFAULT_SSL_VERSION = 'SSLv23'
+
+      def initialize(url, options)
+        @uri = URI.parse(url)
+        @options = options
+      end
+
+      def call
+        socket = TCPSocket.new(uri.host, port)
+        socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+        socket = process_secure(socket) if secure?
+        socket
+      end
+
+      def secure?
+        %w[https wss].include? uri.scheme
+      end
+
+      private
+
+      def port
+        uri.port || (uri.scheme == 'wss' ? 443 : 80)
+      end
+
+      def process_secure(socket)
+        ssl_context = options[:ssl_context] || context
+
+        socket = ::OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
+        socket.hostname = uri.host
+        socket.connect
+        socket
+      end
+
+      def context
+        context = OpenSSL::SSL::SSLContext.new
+        context.ssl_version = options[:ssl_version] || DEFAULT_SSL_VERSION
+        context.verify_mode = options[:verify_mode] || OpenSSL::SSL::VERIFY_PEER
+        context.cert_store  = options[:cert_store] || default_cert_store
+        context
+      end
+
+      def default_cert_store
+        cert_store = OpenSSL::X509::Store.new
+        cert_store.set_default_paths
+        cert_store
+      end
+    end
+  end
+end

data/lib/weso/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Weso
+  VERSION = '0.1.1'
+end

data/weso.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/weso/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'weso'
+  spec.version       = Weso::VERSION
+  spec.authors       = ['Roman Ovcharov']
+  spec.email         = ['overchind@gmail.com']
+
+  spec.summary       = 'Ruby Websocket Client with the idea of simplicity and efficiency.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/overchind/weso'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/overchind/weso'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.9.0'
+
+  spec.add_dependency 'event_emitter', '~> 0.2.6'
+  spec.add_dependency 'openssl', '~> 2.1.2'
+  spec.add_dependency 'uri', '~> 0.10.0'
+  spec.add_dependency 'websocket', '~> 1.2.8'
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: weso
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Roman Ovcharov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: event_emitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+description: Ruby Websocket Client with the idea of simplicity and efficiency.
+email:
+- overchind@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/weso.rb
+- lib/weso/base.rb
+- lib/weso/client.rb
+- lib/weso/socket_creator.rb
+- lib/weso/version.rb
+- weso.gemspec
+homepage: https://github.com/overchind/weso
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/overchind/weso
+  source_code_uri: https://github.com/overchind/weso
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby Websocket Client with the idea of simplicity and efficiency.
+test_files: []