ws_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd2fc6088397e593b00bbee38113f2778502cd63
+  data.tar.gz: 9aa868c516d06787d697eaf73e5bae2da859926a
+SHA512:
+  metadata.gz: 50eb7efd6162a6b0422a269c6c146e426b4414182000fc88fd4c698191aba0ffc0d3c749b537716d6938f76f2c9881539bd8cc5953161ffc7099646e359f2f31
+  data.tar.gz: 83f023b52c171e79436529a19c6a948bbe17649117c594328f04a7d235ccf2b67246c65dfc6038da6798242ff02b47234609286fb387f0d4237148a9b22b9ffe

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ws_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Brandon Dewitt
+
+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,41 @@
+# WsClient
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ws_client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ws_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ws_client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, 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/[USERNAME]/ws_client.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ws_client"
+
+# 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

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/ws_client/version.rb

@@ -0,0 +1,3 @@
+module WsClient
+  VERSION = "0.1.0"
+end

data/lib/ws_client.rb

@@ -0,0 +1,201 @@
+require 'thread'
+require 'event_emitter'
+require 'websocket'
+require 'socket'
+require 'openssl'
+require 'uri'
+require "ws_client/version"
+
+module WsClient
+  def self.connect(url, options={})
+    client = ::WsClient::Client.new
+    yield client if block_given?
+    client.connect url, options
+    return client
+  end
+
+  class Client
+    include EventEmitter
+    attr_reader :url, :handshake, :message_queue, :connect_options
+
+    MS_2 = (1/500.0)
+    FRAME_SIZE = 2048
+
+    def initialize
+      @message_queue = ::Queue.new
+    end
+
+    def connect(url = nil, options={})
+      return if open?
+
+      @connect_options = options
+      @connect_url = @url = url || @connect_url || @url
+
+      raise "No URL to connect to" if url.nil?
+
+      uri = URI.parse url
+      @socket = TCPSocket.new(uri.host, uri.port || (uri.scheme == 'wss' ? 443 : 80))
+      @socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+
+      if ['https', 'wss'].include?(uri.scheme)
+        ssl_context = options[:ssl_context] || begin
+        ctx = OpenSSL::SSL::SSLContext.new
+        ctx.ssl_version = options[:ssl_version] || 'SSLv23'
+        ctx.verify_mode = options[:verify_mode] || OpenSSL::SSL::VERIFY_NONE #use VERIFY_PEER for verification
+        cert_store = OpenSSL::X509::Store.new
+        cert_store.set_default_paths
+        ctx.cert_store = cert_store
+        ctx
+        end
+
+        @socket = ::OpenSSL::SSL::SSLSocket.new(@socket, ssl_context)
+        @socket.connect
+      end
+
+      @pipe_broken = false
+      @closed = false
+
+      handshake
+    end
+
+    def reconnect
+      connect(nil)
+    end
+
+    def send_data(data, opt={:type => :text})
+      @thread ||= poll # utilize the polling interface, could probably be split into another class
+      write_data(data, opt)
+    end
+
+    # Returns all responses that have been accepted
+    def send_data_and_wait(data, timeout, opt = { :type => :text })
+      response_data = []
+      write_data(data, opt)
+      pull_next_message_off_of_socket(@socket, timeout)
+      pull_next_message_off_of_socket(@socket, MS_2) # 2ms penalty to check for additional messages
+
+      if message_queue.length > 0
+        message_queue.length.times do
+          response_data << message_queue.pop
+        end
+      end
+
+      response_data
+    end
+
+    def close
+      return if @closed
+
+      send_data nil, :type => :close if !@pipe_broken
+      emit :close
+    ensure
+      @closed = true
+      @socket.close if @socket
+      @socket = nil
+      Thread.kill @thread if @thread
+    end
+
+    def closed?
+      !open?
+    end
+
+    def open?
+      @handshake && @handshake.finished? && !@closed
+    end
+
+    private
+
+    def handshake
+      @handshake = ::WebSocket::Handshake::Client.new :url => url, :headers => @connect_options[:headers]
+      @handshaked = false
+      @socket.write @handshake.to_s
+
+      while !@handshaked
+        begin
+          read_sockets, _, _ = IO.select([@socket], nil, nil, 10)
+
+          if read_sockets && read_sockets[0]
+            @handshake << @socket.read_nonblock(FRAME_SIZE)
+
+            if @socket.respond_to?(:pending) # SSLSocket
+              @handshake << @socket.read(@socket.pending) while @socket.pending > 0
+            end
+
+            @handshaked = @handshake.finished?
+          end
+        rescue IO::WaitReadable
+          retry
+        rescue IO::WaitWritable
+          IO.select(nil, [socket])
+          retry
+        end
+      end
+
+      emit :open if @handshaked
+    end
+
+    def poll
+      return Thread.new(@socket) do |socket|
+        while !@closed do
+          pull_next_message_off_of_socket(socket)
+
+          message_queue.length.times do
+            emit :message, message_queue.pop
+          end
+        end
+      end
+    end
+
+    def pull_next_message_off_of_socket(socket, timeout = 10, last_frame = nil)
+      read_sockets, _, _ = IO.select([socket], nil, nil, timeout)
+
+      if read_sockets && read_sockets[0]
+        frame = last_frame || ::WebSocket::Frame::Incoming::Client.new
+
+        begin
+          frame << socket.read_nonblock(FRAME_SIZE)
+
+          if socket.respond_to?(:pending)
+            frame << socket.read(socket.pending) while socket.pending > 0
+          end
+
+          if msg = frame.next
+            message_queue << msg
+            pull_next_message_off_of_socket(socket, MS_2) # 2ms penalty for new frames
+          else
+            pull_next_message_off_of_socket(socket, timeout, frame)
+          end
+        rescue IO::WaitReadable
+          IO.select([socket])
+          retry
+        rescue IO::WaitWritable
+          IO.select(nil, [socket])
+          retry
+        rescue => e
+          close
+          emit :error, e
+        end
+      end
+    end
+
+    def write_data(data, opt)
+      frame = ::WebSocket::Frame::Outgoing::Client.new(:data => data, :type => opt[:type], :version => @handshake.version)
+
+      begin
+        @socket.write_nonblock(frame.to_s)
+      rescue IO::WaitReadable
+        IO.select([@socket]) # OpenSSL needs to read internally
+        retry
+      rescue IO::WaitWritable, Errno::EINTR
+        IO.select(nil, [@socket])
+        retry
+      rescue Errno::EPIPE => e
+        @pipe_broken = true
+        close
+      rescue => e
+        close
+        emit :error, e
+      end
+    end
+  end
+end

data/ws_client.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ws_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ws_client"
+  spec.version       = WsClient::VERSION
+  spec.authors       = ["Brandon Dewitt", "Sho Hashimoto"]
+  spec.email         = ["brandonsdewitt+rubygems@gmail.com"]
+
+  spec.summary       = %q{ A Simple websocket client in ruby ... largely from websocket-client-simple
+                           with changes merged to use send_data over send and includes send_data_and_wait }
+  spec.description   = %q{ Simple websocket client in ruby }
+  spec.homepage      = "https://github.com/abrandoned/ws_client"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "websocket"
+  spec.add_dependency "event_emitter"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: ws_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Dewitt
+- Sho Hashimoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: event_emitter
+  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: " Simple websocket client in ruby "
+email:
+- brandonsdewitt+rubygems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ws_client.rb
+- lib/ws_client/version.rb
+- ws_client.gemspec
+homepage: https://github.com/abrandoned/ws_client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A Simple websocket client in ruby ... largely from websocket-client-simple
+  with changes merged to use send_data over send and includes send_data_and_wait
+test_files: []