ws_sync_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd880be25c6299668ed273d8f8f4345809447191
-  data.tar.gz: a4cf1207d81d14513c5cf0f9828570ba135b5a5e
+  metadata.gz: b34d7e77b43d316bf5bb2e433040172f4de60cc3
+  data.tar.gz: f5ae8f8251e7f64b34e503cf3a320495681926fc
 SHA512:
-  metadata.gz: 66fc604c66760b5d417e010cc8a2d3ee3a8596a4d28ccca319d5509c5ed27ba898e1e95c229555ac44f69596ef7970e164d0a1a16506996bbc13057f9eb0d161
-  data.tar.gz: 7621ceb91d7e8cbbb2cc4ad289ed40c27564dd20d7629108cd119a1995973f0173934bc7fb4ae42ca7c130bddf664c13c437680289ff6e2c6fc05252f4b19678
+  metadata.gz: bfabbd28c1ad2ff9e5ee257d2765eee3e728971203a7f3d8877aa89832e86f592a68602af680824571c63488343d02dc67ca6c2a5e1043f19f7724a9b9020e1f
+  data.tar.gz: 331266fc5c667fa37546c1b0b1ed33cfb7e8375f8435919dd6ae11eac6aa8f71f666ae1ca9b7c24312bcc637b8e8db3cc71857a11e319793dd1d14c48d30d935

data/{README.rdoc → README.md}

@@ -1,9 +1,19 @@
-= ws_sync
+# ws_sync_client
 
-Description goes here.
+Synchronous Ruby client for
+[the WebSocket protocol](http://tools.ietf.org/html/rfc6455).
+
+## Usage
+
+```ruby
+ws = WsSyncClient 'ws://localhost:4567/path'
+data_frame = ws.recv_frame
+ws.send_frame "Data frame"
+ws.close
+```
+
+## Contributing to ws_sync
 
-== 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.
@@ -12,8 +22,6 @@ Description goes here.
 * 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.
+## Copyright
 
+Copyright (c) 2014 Victor Costan. See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/ws_sync_client.rb

@@ -9,7 +9,6 @@ class WsSyncClient
   # @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
@@ -25,7 +24,9 @@ class WsSyncClient
     @closed = false
     @incoming = WebSocket::Frame::Incoming::Client.new(
         version: @handshake.version)
-    @incoming << @handshake.leftovers
+    if leftovers = @handshake.leftovers
+      @incoming << leftovers
+    end
   end
 
   # Send a WebSocket frame.

data/test/fixtures/ws_server.rb

@@ -26,9 +26,11 @@ 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'])
+      unless handshake.query['echo_handshake'] == 'false'
+        ws.send JSON.dump(handshake: 'completed', path: handshake.path,
+                          query: handshake.query_string,
+                          host: handshake.headers['Host'])
+      end
     end
 
     ws.onmessage do |message|
@@ -36,11 +38,14 @@ EM.run do
       case command['cmd']
       when 'echo'
         response = { status: 'ok', seq: command['seq'], data: command['data'] }
+      when 'close'
+        ws.close command['code'], command['reason']
+        response = nil
       else
         response = { status: 'error', seq: command['seq'],
                      reason: 'unknown command' }
       end
-      ws.send JSON.dump(response)
+      ws.send JSON.dump(response) unless response.nil?
     end
 
     ws.onclose do

data/test/test_ws_sync_client.rb

@@ -63,4 +63,65 @@ describe 'WsSync' do
       end
     end
   end
+
+  describe '#close' do
+    it 'does not crash' do
+      @ws.close
+    end
+
+    it 'causes #send_frame to raise an exception' do
+      @ws.close
+      lambda {
+        @ws.send_frame JSON.dump(cmd: 'echo', seq: 1, data: 'Hello world!')
+      }.must_raise IOError
+    end
+
+    it 'causes #recv_frame to raise an exception' do
+      parsed = JSON.parse @ws.recv_frame
+      parsed['handshake'].must_equal 'completed'
+
+      @ws.close
+      lambda {
+        @ws.recv_frame
+      }.must_raise IOError
+    end
+  end
+
+  describe 'when the server closes the socket' do
+    before do
+      parsed = JSON.parse @ws.recv_frame
+      unless parsed['handshake'] == 'completed'
+        raise 'Setup error'
+      end
+      @ws.send_frame JSON.dump(cmd: 'close', seq: 1, code: 4321,
+                               reason: 'testing server-side closing')
+    end
+
+    it '#recv_frame raises an exception' do
+      lambda {
+        @ws.recv_frame
+      }.must_raise IOError
+    end
+
+    it '#close does not crash' do
+      @ws.close
+    end
+  end
+end
+
+describe 'WsSync' do
+  describe 'without a handshake echo' do
+    before do
+      @ws = WsSyncClient.new server_root_url + "/?echo_handshake=false"
+    end
+    after do
+      @ws.close
+    end
+
+    it 'completes a send/receive cycle' do
+      @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
+  end
 end

data/ws_sync_client.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "ws_sync_client"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Victor Costan"]
+  s.date = "2014-03-16"
+  s.description = "WebSocket client that does not require asynchronous programming"
+  s.email = "costan@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/ws_sync_client.rb",
+    "test/fixtures/ws_server.rb",
+    "test/helper.rb",
+    "test/test_ws_sync_client.rb",
+    "ws_sync_client.gemspec"
+  ]
+  s.homepage = "http://github.com/pwnall/ws_sync_client"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.14"
+  s.summary = "Synchronous WebSocket client"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<websocket>, [">= 1.1.2"])
+      s.add_runtime_dependency(%q<websocket-native>, [">= 1.0.0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.5.3"])
+      s.add_development_dependency(%q<debugger>, [">= 1.6.6"])
+      s.add_development_dependency(%q<em-websocket>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 2.0.1"])
+      s.add_development_dependency(%q<minitest>, [">= 5.3.0"])
+      s.add_development_dependency(%q<rdoc>, [">= 4.1.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0.8.2"])
+      s.add_development_dependency(%q<yard>, [">= 0.8.7.3"])
+    else
+      s.add_dependency(%q<websocket>, [">= 1.1.2"])
+      s.add_dependency(%q<websocket-native>, [">= 1.0.0"])
+      s.add_dependency(%q<bundler>, [">= 1.5.3"])
+      s.add_dependency(%q<debugger>, [">= 1.6.6"])
+      s.add_dependency(%q<em-websocket>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 2.0.1"])
+      s.add_dependency(%q<minitest>, [">= 5.3.0"])
+      s.add_dependency(%q<rdoc>, [">= 4.1.1"])
+      s.add_dependency(%q<simplecov>, [">= 0.8.2"])
+      s.add_dependency(%q<yard>, [">= 0.8.7.3"])
+    end
+  else
+    s.add_dependency(%q<websocket>, [">= 1.1.2"])
+    s.add_dependency(%q<websocket-native>, [">= 1.0.0"])
+    s.add_dependency(%q<bundler>, [">= 1.5.3"])
+    s.add_dependency(%q<debugger>, [">= 1.6.6"])
+    s.add_dependency(%q<em-websocket>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 2.0.1"])
+    s.add_dependency(%q<minitest>, [">= 5.3.0"])
+    s.add_dependency(%q<rdoc>, [">= 4.1.1"])
+    s.add_dependency(%q<simplecov>, [">= 0.8.2"])
+    s.add_dependency(%q<yard>, [">= 0.8.7.3"])
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ws_sync_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Victor Costan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket
@@ -156,19 +156,20 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/ws_sync_client.rb
 - test/fixtures/ws_server.rb
 - test/helper.rb
 - test/test_ws_sync_client.rb
+- ws_sync_client.gemspec
 homepage: http://github.com/pwnall/ws_sync_client
 licenses:
 - MIT