websocketio 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d9761e5661e390bd615bd8f6f195c93813f5c06
+  data.tar.gz: cffb0529922148010360e0f89db9d5e5064fd005
+SHA512:
+  metadata.gz: f34470bc4e66bbff0ed97fb7b1dde924e797fe8afeb6c942a9d878e9df41a3dd7c39583c1e2bc5f3195982163eb672d1107c67e35e50b5ce3df84146b66b8914
+  data.tar.gz: 1f8bda924a87be3f233240e7d6dcc822fa32a7a60356ffff09a39840bf91d608d95885e3f54039852bef6662f24439d7df664b6ee2695ef53276a4bf7324a553

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.0.0
+  - 1.9.3
+script: "bundle exec rspec"
+before_install:
+  - "gem install bundler -v 1.9.4"

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Takeshi Horiuchi
+
+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,61 @@
+# WebSocketIO
+
+[![Build Status](https://travis-ci.org/keshihoriuchi/ruby-websocketio.svg)](https://travis-ci.org/keshihoriuchi/ruby-websocketio)
+
+WebSocketIO is a Ruby library. It aims to capacitate applications or libraries implemented with TCPSocket to communicate with WebSocket easily.
+
+WebSocketIO::Client is a object which can communicate through WebSocket with same interface as TCPSocket.
+
+Inspired by [websocket-stream](https://github.com/maxogden/websocket-stream) of Node.js
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'websocketio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install websocketio
+
+## Usage
+
+```ruby
+require 'websocketio'
+
+tcpsocket = TCPSocket.new('localhost', 8080)
+websocketio = WebSocketIO::Client.new(tcpsocket, url: 'ws://localhost:8080')
+websocketio.write 'How are you?'
+
+trap('INT') { websocketio.close }
+while c = websocket.read(1) do
+  STDOUT << c
+end
+```
+
+### new(socket, handshake\_args) -> WebSocketIO::Client
+#### socket
+
+It requires a connected socket object.
+All sockets which have same interface as TCPSocket are available.
+When you want to connect over proxy, you may use [ruby-proxifier](https://github.com/samuelkadolph/ruby-proxifier). See `example` directory.
+
+#### handshake\_args
+
+Parameters for WebSocket handshaking.
+This arg is given to `WebSocket::Handshake::Client.new` which is defined at [websocket-ruby](https://github.com/imanel/websocket-ruby#client-handshake).
+
+## Implemented
+
+* WebSocketIO::Client
+    * new
+    * write
+    * read
+    * getc
+    * close

data/Rakefile

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

data/lib/websocketio.rb

@@ -0,0 +1,4 @@
+# coding: utf-8
+
+require 'websocketio/version'
+require 'websocketio/client'

data/lib/websocketio/client.rb

@@ -0,0 +1,68 @@
+# coding: utf-8
+
+require 'websocket'
+require 'filter_io'
+require 'forwardable'
+
+module WebSocketIO
+  class Client
+    extend Forwardable
+
+    def_delegators :@filtered_socket, :read, :getc
+
+    def initialize(socket, handshake_args)
+      @socket = socket
+      @handshake = WebSocket::Handshake::Client.new(handshake_args)
+      @socket.write @handshake.to_s
+      until @handshake.finished? do
+        @handshake << @socket.getc
+      end
+
+      # TODO: FilterIO assume that eof? isn't blocking method. But TCPSocket#eof? is.
+      # See http://docs.ruby-lang.org/en/2.2.0/IO.html#method-i-eof-3F
+      def @socket.eof?; closed?; end
+      @filtered_socket = filter(@socket, @handshake.version)
+    end
+
+    def close
+      send_frame type: :close
+      @socket.close
+      @socket = nil
+      @closed = true
+    end
+
+    def closed?
+      @closed
+    end
+
+    def write(str)
+      send_frame data: str
+      str.to_s.bytesize
+    end
+
+    private
+
+    def send_frame(params)
+      params = {
+        data:    nil,
+        type:    :text,
+        version: @handshake.version
+      }.merge(params)
+      frame = WebSocket::Frame::Outgoing::Client.new(params)
+      @socket.write frame.to_s
+    end
+
+    def filter(socket, version)
+      frame = WebSocket::Frame::Incoming::Client.new(version: version)
+      pushed_size = 0
+      FilterIO.new socket, block_size: 1 do |data|
+        frame << data[pushed_size]
+        pushed_size += 1
+        buffered = frame.next
+        raise FilterIO::NeedMoreData unless buffered
+        pushed_size = 0
+        buffered.to_s
+      end
+    end
+  end
+end

data/lib/websocketio/version.rb

@@ -0,0 +1,5 @@
+# coding: utf-8
+
+module WebSocketIO
+  VERSION = "0.0.1"
+end

data/websocketio.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'websocketio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "websocketio"
+  spec.version       = WebSocketIO::VERSION
+  spec.authors       = ["Takeshi Horiuchi"]
+  spec.email         = ["keshihoriuchi@gmail.com"]
+
+  spec.summary       = 'Communicate through WebSocket with same interface as TCPSocket.'
+  spec.description   = 'Communicate through WebSocket with same interface as TCPSocket.'
+  spec.homepage      = "https://github.com/keshihoriuchi/ruby-websocketio"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|example)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "websocket-eventmachine-server"
+  spec.add_development_dependency "proxifier"
+  spec.add_dependency "websocket"
+  spec.add_dependency "filter_io"
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: websocketio
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takeshi Horiuchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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-eventmachine-server
+  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: proxifier
+  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: filter_io
+  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: Communicate through WebSocket with same interface as TCPSocket.
+email:
+- keshihoriuchi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/websocketio.rb
+- lib/websocketio/client.rb
+- lib/websocketio/version.rb
+- websocketio.gemspec
+homepage: https://github.com/keshihoriuchi/ruby-websocketio
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Communicate through WebSocket with same interface as TCPSocket.
+test_files: []