ws_sync_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd880be25c6299668ed273d8f8f4345809447191
+  data.tar.gz: a4cf1207d81d14513c5cf0f9828570ba135b5a5e
+SHA512:
+  metadata.gz: 66fc604c66760b5d417e010cc8a2d3ee3a8596a4d28ccca319d5509c5ed27ba898e1e95c229555ac44f69596ef7970e164d0a1a16506996bbc13057f9eb0d161
+  data.tar.gz: 7621ceb91d7e8cbbb2cc4ad289ed40c27564dd20d7629108cd119a1995973f0173934bc7fb4ae42ca7c130bddf664c13c437680289ff6e2c6fc05252f4b19678

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source 'http://rubygems.org'
+gem 'websocket', '>= 1.1.2'
+gem 'websocket-native', '>= 1.0.0'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'bundler', '>= 1.5.3'
+  gem 'debugger', '>= 1.6.6'
+  gem 'em-websocket', '>= 0'
+  gem 'jeweler', '>= 2.0.1'
+  gem 'minitest', '>= 5.3.0'
+  gem 'rdoc', '>= 4.1.1'
+  gem 'simplecov', '>= 0.8.2'
+  gem 'yard', '>= 0.8.7.3'
+end

data/Gemfile.lock

@@ -0,0 +1,84 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    columnize (0.3.6)
+    debugger (1.6.6)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.2)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.2)
+    descendants_tracker (0.0.3)
+    docile (1.1.3)
+    em-websocket (0.5.0)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.5.3)
+    eventmachine (1.0.3)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.6)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.21)
+    http_parser.rb (0.5.3)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    mini_portile (0.5.2)
+    minitest (5.3.0)
+    multi_json (1.9.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    websocket (1.1.2)
+    websocket-native (1.0.0)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.5.3)
+  debugger (>= 1.6.6)
+  em-websocket
+  jeweler (>= 2.0.1)
+  minitest (>= 5.3.0)
+  rdoc (>= 4.1.1)
+  simplecov (>= 0.8.2)
+  websocket (>= 1.1.2)
+  websocket-native (>= 1.0.0)
+  yard (>= 0.8.7.3)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Victor Costan
+
+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.rdoc

@@ -0,0 +1,19 @@
+= ws_sync
+
+Description goes here.
+
+== Contributing to ws_sync
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Victor Costan. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "ws_sync_client"
+  gem.homepage = "http://github.com/pwnall/ws_sync_client"
+  gem.license = "MIT"
+  gem.summary = %Q{Synchronous WebSocket client}
+  gem.description = %Q{WebSocket client that does not require asynchronous programming}
+  gem.email = "costan@gmail.com"
+  gem.authors = ["Victor Costan"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/ws_sync_client.rb

@@ -0,0 +1,133 @@
+require 'socket'  # For Addrinfo.
+
+require 'websocket'
+
+# Synchronous socket.
+class WsSyncClient
+  # Create a socket.
+  #
+  # @param [String] url a ws:// URL
+  # @param [Hash] options socket creation options
+  # @option options [Socket] raw create this socket on top of a raw socket.
+  #
+  def initialize(url, options = {})
+    @url = url
+    @handshake = WebSocket::Handshake::Client.new url: @url
+
+    if options[:raw]
+      @socket = options[:raw]
+    else
+      @socket = self.class.raw_socket @handshake.host, @handshake.port
+    end
+    @max_recv = 4096
+
+    handshake
+    @closed = false
+    @incoming = WebSocket::Frame::Incoming::Client.new(
+        version: @handshake.version)
+    @incoming << @handshake.leftovers
+  end
+
+  # Send a WebSocket frame.
+  #
+  # @param [String] data the data to be sent
+  def send_frame(data)
+    frame = WebSocket::Frame::Outgoing::Client.new version: @handshake.version,
+        data: data, type: :text
+    @socket.send frame.to_s, 0
+  end
+
+  # Receive a WebSocket frame.
+  #
+  # @return [String] the frame data
+  def recv_frame
+    loop do
+      frame = @incoming.next
+      if frame.nil?
+        recv_bytes
+        next
+      end
+
+      case frame.type
+      when :text
+        return frame.data
+      when :binary
+        return frame.data
+      when :ping
+        send_pong frame.data
+      when :pong
+        # Ignore pong, since we don't ping.
+      when :close
+        @socket.close
+        @closed = true
+      end
+    end
+  end
+
+  # Closes the WebSocket.
+  #
+  # @param [Integer] code
+  # @param [String] reason
+  def close(code = 0, reason = '')
+    return if @closed
+    frame = WebSocket::Frame::Outgoing::Client.new version: @handshake.version,
+        data: '', type: :close
+    @socket.send frame.to_s, 0
+    @socket.close
+    @closed = true
+  end
+
+  # Complete the WebSocket handshake.
+  #
+  # @private
+  # This is used in the constructor
+  def handshake
+    @socket.send @handshake.to_s, 0
+
+    until @handshake.finished?
+      bytes = @socket.recv @max_recv
+      @handshake << bytes
+    end
+    unless @handshake.valid?
+      raise RuntimeError, 'Invalid WebSocket handshake'
+    end
+  end
+  private :handshake
+
+  # Receive a packet from the underlying raw socket.
+  #
+  # @private
+  # This is used in {WsSync#recv_frame}.
+  def recv_bytes
+    bytes = @socket.recv @max_recv
+    @incoming << bytes
+  end
+  private :recv_bytes
+
+  # Send
+  def send_pong(ping_data)
+    frame = WebSocket::Frame::Outgoing::Client.new version: @handshake.version,
+        data: ping_data, type: :pong
+    @socket.send frame.to_s, 0
+  end
+  private :send_pong
+
+  # Create a raw Socket connected to a host and port.
+  #
+  # @param [String] host hostname (e.g., DNS, mDNS, "localhost" name)
+  # @param [Integer] port the port that the server listens to
+  # @param [Number] timeout number of seconds to wait for the connection to
+  #   succeed
+  # @return [Socket] the raw socket
+  def self.raw_socket(host, port, timeout = 30)
+    Addrinfo.foreach host, port, nil, :STREAM, nil,
+                     Socket::AI_NUMERICSERV do |info|
+      begin
+        return info.connect
+      rescue StandardError
+        # Try the next address.
+      end
+    end
+    nil
+  end
+end

data/test/fixtures/ws_server.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+# Tiny WebSocket test server for WsSync.
+#
+#
+#
+# Manual testing sequence for this test server:
+#
+# $ npm install -g ws
+# $ wscat --connect ws://localhost:9969/hello/world?ohai
+# connected (press CTRL+C to quit)
+#
+# < {"handshake":"completed","path":"/hello/world","query":"ohai","host":"localhost:9969"}
+# > {"cmd":"echo", "seq": 666, "data": "Boom headshot!"}
+#
+# < {"status":"ok","seq":666,"data":"Boom headshot!"}
+# > {"cmd":"echo ", "seq": 666, "data": "Boom headshot!"}
+#
+# < {"status":"error","seq":666,"reason":"unknown command"}
+# (press Ctrl+C)
+
+require 'json'
+require 'rubygems'
+require 'em-websocket'
+
+EM.run do
+  EM::WebSocket.run host: '0.0.0.0', port: 9969 do |ws|
+    ws.onopen do |handshake|
+      ws.send JSON.dump(handshake: 'completed', path: handshake.path,
+                        query: handshake.query_string,
+                        host: handshake.headers['Host'])
+    end
+
+    ws.onmessage do |message|
+      command = JSON.parse message
+      case command['cmd']
+      when 'echo'
+        response = { status: 'ok', seq: command['seq'], data: command['data'] }
+      else
+        response = { status: 'error', seq: command['seq'],
+                     reason: 'unknown command' }
+      end
+      ws.send JSON.dump(response)
+    end
+
+    ws.onclose do
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require 'simplecov'
+SimpleCov.start
+
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ws_sync_client'
+
+require 'net/http'
+
+# Launch a test WebSockets server and wait until it starts.
+module RunServerInMinitest
+  def before_setup
+    super
+    @_server_pid = Process.spawn 'bundle exec test/fixtures/ws_server.rb'
+    Process.detach @_server_pid
+
+    loop do
+      begin
+        response = Net::HTTP.get_response URI.parse('http://localhost:9969')
+        break if response.kind_of?(Net::HTTPSuccess)
+      rescue EOFError
+        break
+      rescue SystemCallError
+        sleep 0.1
+      end
+    end
+  end
+
+  def after_teardown
+    Process.kill 'TERM', @_server_pid
+    super
+  end
+
+  def server_root_url
+    "ws://localhost:9969"
+  end
+end
+class MiniTest::Test
+  include RunServerInMinitest
+end
+
+
+class MiniTest::Test
+end

data/test/test_ws_sync_client.rb

@@ -0,0 +1,66 @@
+require 'helper'
+
+describe 'WsSync' do
+  before do
+    @ws = WsSyncClient.new server_root_url + "/hello/world?answer=42"
+  end
+  after do
+    @ws.close
+  end
+
+  describe '#recv_frame' do
+    it 'receives the handshake' do
+      parsed = JSON.parse @ws.recv_frame
+      parsed.must_equal 'handshake' => 'completed', 'path' => '/hello/world',
+          'query' => 'answer=42', 'host' => 'localhost:9969'
+    end
+  end
+
+  describe '#send_frame' do
+    it 'completes a handshake/echo cycle' do
+      parsed = JSON.parse @ws.recv_frame
+      parsed['handshake'].must_equal 'completed'
+
+      @ws.send_frame JSON.dump(cmd: 'echo', seq: 1, data: 'Hello world!')
+      parsed = JSON.parse @ws.recv_frame
+      parsed.must_equal 'status' => 'ok', 'seq' => 1, 'data' => 'Hello world!'
+    end
+
+    it 'completes a handshake/echo cycle with a large payload' do
+      parsed = JSON.parse @ws.recv_frame
+      parsed['handshake'].must_equal 'completed'
+
+      data = 'Hello world!\n' * 10_000
+      @ws.send_frame JSON.dump(cmd: 'echo', seq: 1, data: data)
+      parsed = JSON.parse @ws.recv_frame
+      parsed.must_equal 'status' => 'ok', 'seq' => 1, 'data' => data
+    end
+
+    it 'completes a few synchronous handshake/echo cycles' do
+      parsed = JSON.parse @ws.recv_frame
+      parsed['handshake'].must_equal 'completed'
+
+      1.upto 32 do |seq|
+        @ws.send_frame JSON.dump(cmd: 'echo', seq: seq, data: 'Hello world!')
+        parsed = JSON.parse @ws.recv_frame
+        parsed.must_equal 'status' => 'ok', 'seq' => seq,
+                          'data' => 'Hello world!'
+      end
+    end
+
+    it 'completes a few asynchronous handshake/echo cycles' do
+      parsed = JSON.parse @ws.recv_frame
+      parsed['handshake'].must_equal 'completed'
+
+      1.upto 32 do |seq|
+        @ws.send_frame JSON.dump(cmd: 'echo', seq: seq, data: 'Hello world!')
+      end
+
+      1.upto 32 do |seq|
+        parsed = JSON.parse @ws.recv_frame
+        parsed.must_equal 'status' => 'ok', 'seq' => seq,
+                          'data' => 'Hello world!'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: ws_sync_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Victor Costan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: websocket-native
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  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: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.3
+description: WebSocket client that does not require asynchronous programming
+email: costan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/ws_sync_client.rb
+- test/fixtures/ws_server.rb
+- test/helper.rb
+- test/test_ws_sync_client.rb
+homepage: http://github.com/pwnall/ws_sync_client
+licenses:
+- MIT
+metadata: {}
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Synchronous WebSocket client
+test_files: []