rfc-ws-client 0.0.1 → 0.0.2

data/README.md

@@ -1,16 +1,27 @@
-# RFC Websocket Client (rfc-ws-client)
+# RFC WebSocket Client (rfc-ws-client)
 
-A simple RFC 6455 (Websocket) compatible client in ruby.
+A simple (more-or-less) RFC 6455 (WebSocket) compatible client without external dependencies.
+
+Currently doesn't support fragmentation.
+
+Includes source code from [em-ws-client](https://github.com/dansimpson/em-ws-client) and [web-socket-ruby](https://github.com/gimite/web-socket-ruby).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'rfc-ws-client'
+```ruby
+gem 'rfc-ws-client'
+```
 
 ## Usage
 
-
+```ruby
+ws = RfcWebSocket::WebSocket.new("wss://echo.websocket.org")
+ws.send_message("test")
+ws.receive # => "test"
+ws.close
+```
 
 ## Contributing
 

data/examples/echo.rb

@@ -2,14 +2,14 @@ $: << File.dirname(__FILE__) + "/../lib"
 
 require "rfc-ws-client"
 
-ws = RfcWebsocket::Websocket.new("ws://localhost:9001/getCaseCount")
+ws = RfcWebSocket::WebSocket.new("ws://localhost:9001/getCaseCount")
 count = ws.receive()[0].to_i
 ws.close
 
 (1..count).each do |i|
   puts "#{i}/#{count}"
   begin
-    ws = RfcWebsocket::Websocket.new "ws://localhost:9001/runCase?&case=#{i}&agent=rfc-ws-client"
+    ws = RfcWebSocket::WebSocket.new "ws://localhost:9001/runCase?&case=#{i}&agent=rfc-ws-client"
     while true
       data, binary = ws.receive
       break if data.nil?
@@ -20,5 +20,5 @@ ws.close
 end
 
 puts "Updating reports and shutting down"
-ws = RfcWebsocket::Websocket.new "ws://localhost:9001/updateReports?agent=rfc-ws-client"
+ws = RfcWebSocket::WebSocket.new "ws://localhost:9001/updateReports?agent=rfc-ws-client"
 ws.receive

data/lib/rfc-ws-client/version.rb

@@ -1,3 +1,3 @@
-module RfcWebsocket
-  VERSION = "0.0.1"
+module RfcWebSocket
+  VERSION = "0.0.2"
 end

data/lib/rfc-ws-client.rb

@@ -8,8 +8,8 @@ require "digest/sha1"
 require 'rainbow'
 require 'base64'
 
-module RfcWebsocket
-  class Websocket
+module RfcWebSocket
+  class WebSocket
     WEB_SOCKET_GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
     OPCODE_CONTINUATION = 0x01
     OPCODE_TEXT = 0x01

data/rfc-ws-client.gemspec

@@ -5,10 +5,10 @@ require 'rfc-ws-client/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "rfc-ws-client"
-  gem.version       = RfcWebsocket::VERSION
+  gem.version       = RfcWebSocket::VERSION
   gem.authors       = ["Lucas Clemente"]
   gem.email         = ["luke.clemente@gmail.com"]
-  gem.summary       = %q{A simple Websocket client in ruby}
+  gem.summary       = %q{A simple WebSocket client in ruby}
   gem.homepage      = "https://github.com/lucas-clemente/rfc-ws-client"
 
   gem.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rfc-ws-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -50,5 +50,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A simple Websocket client in ruby
+summary: A simple WebSocket client in ruby
 test_files: []