rfc-ws-client 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Lucas Clemente
+
+MIT License
+
+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,21 @@
+# RFC Websocket Client (rfc-ws-client)
+
+A simple RFC 6455 (Websocket) compatible client in ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rfc-ws-client'
+
+## Usage
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/echo.rb

@@ -0,0 +1,24 @@
+$: << File.dirname(__FILE__) + "/../lib"
+
+require "rfc-ws-client"
+
+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"
+    while true
+      data, binary = ws.receive
+      break if data.nil?
+      ws.send_message data, binary: binary
+    end
+  rescue
+  end
+end
+
+puts "Updating reports and shutting down"
+ws = RfcWebsocket::Websocket.new "ws://localhost:9001/updateReports?agent=rfc-ws-client"
+ws.receive

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

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

data/lib/rfc-ws-client.rb

@@ -0,0 +1,239 @@
+require "rfc-ws-client/version"
+
+require "openssl"
+require 'uri'
+require 'socket'
+require 'securerandom'
+require "digest/sha1"
+require 'rainbow'
+require 'base64'
+
+module RfcWebsocket
+  class Websocket
+    WEB_SOCKET_GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
+    OPCODE_CONTINUATION = 0x01
+    OPCODE_TEXT = 0x01
+    OPCODE_BINARY = 0x02
+    OPCODE_CLOSE = 0x08
+    OPCODE_PING = 0x09
+    OPCODE_PONG = 0x0a
+    DEBUG = false
+
+    def initialize(uri, protocol = "")
+      uri = URI.parse(uri) unless uri.is_a?(URI)
+      @protocol = protocol
+
+      if uri.scheme == "ws"
+        default_port = 80
+      elsif uri.scheme = "wss"
+        default_port = 443
+      else
+        raise "unsupported scheme: #{uri.scheme}"
+      end
+      host = uri.host + ((!uri.port || uri.port == default_port) ? "" : ":#{uri.port}")
+      path = (uri.path.empty? ? "/" : uri.path) + (uri.query ? "?" + uri.query : "")
+
+      @socket = TCPSocket.new(uri.host, uri.port || default_port)
+      if uri.scheme == "wss"
+        @socket = OpenSSL::SSL::SSLSocket.new(@socket)
+        @socket.sync_close = true
+        @socket.connect
+      end
+
+      request_key = SecureRandom::base64(16)
+      write(handshake(host, path, request_key))
+      flush()
+
+      status_line = gets.chomp
+      raise "bad response: #{status_line}" unless status_line.start_with?("HTTP/1.1 101")
+
+      header = {}
+      while line = gets
+        line.chomp!
+        break if line.empty?
+        if !(line =~ /\A(\S+): (.*)\z/n)
+          raise "invalid response: #{line}"
+        end
+        header[$1.downcase] = $2
+      end
+      raise "upgrade missing" unless header["upgrade"]
+      raise "connection missing" unless header["connection"]
+      accept = header["sec-websocket-accept"]
+      raise "sec-websocket-accept missing" unless accept
+      expected_accept = Digest::SHA1.base64digest(request_key + WEB_SOCKET_GUID)
+      raise "sec-websocket-accept is invalid, actual: #{accept}, expected: #{expected_accept}" unless accept == expected_accept
+    end
+
+    def send_message(message, opts = {binary: false})
+      write(encode(message, opts[:binary] ? OPCODE_BINARY : OPCODE_TEXT))
+    end
+
+    def receive
+      begin
+        bytes = read(2).unpack("C*")
+        fin = (bytes[0] & 0x80) != 0
+        opcode = bytes[0] & 0x0f
+        mask = (bytes[1] & 0x80) != 0
+        length = bytes[1] & 0x7f
+        if bytes[0] & 0b01110000 != 0
+          raise "reserved bits must be 0"
+        end
+        if opcode > 7
+          if !fin
+            raise "control frame cannot be fragmented"
+          elsif length > 125
+            raise "Control frame is too large #{length}"
+          elsif opcode > 0xA
+            raise "Unexpected reserved opcode #{opcode}"
+          elsif opcode == OPCODE_CLOSE && length == 1
+            raise "Close control frame with payload of length 1"
+          end
+        else
+          if opcode != OPCODE_CONTINUATION && opcode != OPCODE_TEXT && opcode != OPCODE_BINARY
+            raise "Unexpected reserved opcode #{opcode}"
+          end
+        end
+        if length == 126
+          bytes = read(2)
+          length = bytes.unpack("n")[0]
+        elsif length == 127
+          bytes = read(8)
+          (high, low) = bytes.unpack("NN")
+          length = high * (2 ** 32) + low
+        end
+        mask_key = mask ? read(4).unpack("C*") : nil
+        payload = read(length)
+        payload = apply_mask(payload, mask_key) if mask
+        case opcode
+        when OPCODE_TEXT
+          return payload.force_encoding("UTF-8"), false
+        when OPCODE_BINARY
+          return payload, true
+        when OPCODE_CLOSE
+          code, explain = payload.unpack("nA*")
+          if explain && !explain.force_encoding("UTF-8").valid_encoding?
+            close(1007)
+          else
+            close(response_close_code(code))
+          end
+          return nil, nil
+        when OPCODE_PING
+          write(encode(payload, OPCODE_PONG))
+          #TODO fix recursion
+          return receive
+        when OPCODE_PONG
+          return receive
+        else
+          raise "received unknown opcode: #{opcode}"
+        end
+      rescue EOFError
+        return nil, nil
+      rescue => e
+        close(1002)
+        raise e
+      end
+    end
+
+    def close(code = 1000, msg = nil)
+      write(encode [code ? code : 1000, msg].pack("nA*"), OPCODE_CLOSE)
+      @socket.close
+    end
+
+    private
+
+    def gets(delim = $/)
+      line = @socket.gets(delim)
+      print line.color(:green) if DEBUG
+      line
+    end
+
+    def write(data)
+      print data.color(:yellow) if DEBUG
+      @socket.write(data)
+      @socket.flush
+    end
+
+    def read(num_bytes)
+      str = @socket.read(num_bytes)
+      if str && str.bytesize == num_bytes
+        print str.color(:green) if DEBUG
+        str
+      else
+        raise(EOFError)
+      end
+    end
+
+    def flush
+      @socket.flush
+    end
+
+    def handshake(host, path, request_key)
+      headers = ["GET #{path} HTTP/1.1"]
+      headers << "Connection: keep-alive, Upgrade"
+      headers << "Host: #{host}"
+      headers << "Sec-WebSocket-Key: #{request_key}"
+      headers << "Sec-WebSocket-Version: 13"
+      headers << "Upgrade: websocket"
+      headers << "User-Agent: rfc-ws-client"
+      headers << "\r\n"
+      headers.join "\r\n"
+    end
+
+    def encode(data, opcode)
+      frame = []
+      frame << (opcode | 0x80)
+
+      packr = "CC"
+
+      if opcode == OPCODE_TEXT
+        data.force_encoding("UTF-8")
+        if !data.valid_encoding?
+          raise "Invalid UTF!"
+        end
+      end
+
+      # append frame length and mask bit 0x80
+      len = data ? data.bytesize : 0
+      if len <= 125
+        frame << (len | 0x80)
+      elsif len < 65536
+        frame << (126 | 0x80)
+        frame << len
+        packr << "n"
+      else
+        frame << (127 | 0x80)
+        frame << len
+        packr << "L!>"
+      end
+
+      # generate a masking key
+      key = rand(2 ** 31)
+
+      # mask each byte with the key
+      frame << key
+      packr << "N"
+
+      # Apply the masking key to every byte
+      len.times do |i|
+        frame << ((data.getbyte(i) ^ (key >> ((3 - (i % 4)) * 8))) & 0xFF)
+      end
+
+      frame.pack("#{packr}C*")
+    end
+
+    def response_close_code(code)
+      case code
+      when 1000,1001,1002,1003,1007,1008,1009,1010,1011
+        1000
+      when 3000..3999
+        1000
+      when 4000..4999
+        1000
+      when nil
+        1000
+      else
+        1002
+      end
+    end
+  end
+end

data/rfc-ws-client.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rfc-ws-client/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rfc-ws-client"
+  gem.version       = RfcWebsocket::VERSION
+  gem.authors       = ["Lucas Clemente"]
+  gem.email         = ["luke.clemente@gmail.com"]
+  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($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: rfc-ws-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lucas Clemente
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-19 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- luke.clemente@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/echo.rb
+- lib/rfc-ws-client.rb
+- lib/rfc-ws-client/version.rb
+- rfc-ws-client.gemspec
+homepage: https://github.com/lucas-clemente/rfc-ws-client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple Websocket client in ruby
+test_files: []