WEBSocket 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Matthieu "Ezveus" Ciappara
+
+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,89 @@
+# WEBSocket
+
+Establish a websocket communication using Ruby standard sockets or
+[Celluloid::IO](http://github.com/celluloid/celluloid-io) sockets if
+required.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'WEBSocket'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install WEBSocket
+
+## Usage
+
+
+### WEBSocket::Socket
+
+This socket is a Ruby standard socket unless 'celluloid/io' has been
+required. In both cases, WEBSocket::Socket works as a wrapper of Ruby
+standard socket module.
+
+```ruby
+require 'WEBSocket'
+
+s = WEBSocket::Socket.new 'localhost', 4242
+s.write "Ping"
+pong = s.readpartial 4096
+```
+
+### WEBSocket::server
+
+This server is a Ruby standard server unless 'celluloid/io' has been
+required. In both cases, WEBSocket::Server works as a wrapper of Ruby
+standard socket module.
+
+Here is a standard echoserver
+
+```ruby
+require 'celluloid/io'
+require 'WEBSocket'
+
+class EchoServer
+  include Celluloid::IO
+
+  def initialize host, port
+    puts "*** Starting echo server on #{host}:#{port}"
+
+    @server = WEBSocket::Server.new host, port
+    run!
+  end
+
+  def finalize
+    @server.close if @server
+  end
+
+  def run
+    loop { handle_connection! @server.accept }
+  end
+
+  def handle_connection socket
+    _, port, host = socket.peeraddr
+    puts "*** Received connection from #{host}:#{port}"
+    loop { socket.write socket.readpartial 4096 }
+  rescue EOFError
+    puts "*** #{host}:#{port} disconnected"
+    socket.close
+  end
+end
+
+supervisor = EchoServer.supervise("127.0.0.1", 1234)
+trap("INT") { supervisor.terminate; exit }
+sleep
+```
+
+## 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/WEBSocket.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'WEBSocket/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "WEBSocket"
+  gem.version       = WEBSocket::VERSION
+  gem.date          = WEBSocket::DATE
+  gem.authors       = ["Matthieu \"Ezveus\" Ciappara"]
+  gem.email         = ["ciappam@gmail.com"]
+  gem.description   = <<-EOS
+Establish a websocket communication using Ruby standard sockets or Celluloid::IO sockets if required.
+EOS
+  gem.summary       = %q{Establish a websocket communication}
+  gem.homepage      = "https://github.com/Ezveus/ruby-websocket"
+
+  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"]
+  gem.add_runtime_dependency 'websocket', '~> 1.0.6', '>= 1.0.6'
+end

data/lib/WEBSocket.rb

@@ -0,0 +1,6 @@
+require "websocket"
+require "uri"
+
+require "WEBSocket/version"
+require "WEBSocket/socket"
+require "WEBSocket/server"

data/lib/WEBSocket/Celluloid/server.rb

@@ -0,0 +1,116 @@
+module WEBSocket
+  class Server
+    extend Forwardable
+    def_delegators :@server, :listen, :sysaccept, :close, :closed?, :addr
+
+    class AcceptedSocket
+      extend Forwardable
+      attr_reader :status
+
+      def_delegators :@socket, :close, :closed?
+      def_delegators :@socket, :addr, :peeraddr, :setsockopt
+
+      def acquire_ownership type
+        @socket.acquire_ownership type
+      end
+
+      def connect
+        @handshake = WebSocket::Handshake::Server.new
+        msg = @socket.readpartial 4096
+        @handshake << msg
+        until @handshake.finished?
+          msg = @socket.readpartial 4096
+          @handshake << msg
+        end
+        if @handshake.valid?
+          @socket.write @handshake.to_s
+          @status = :connected
+        end
+        self
+      end
+
+      def evented?
+        @socket.evented?
+      end
+
+      def initialize socket
+        @socket = socket
+        @status = :disconnected
+      end
+
+      def read length = nil, buffer = nil
+        s = @socket.read length, buffer
+        frame = WebSocket::Frame::Incoming::Server.new :version => @handshake.version
+        frame << s
+        frame.next.to_s
+      end
+
+      def read_nonblock length, buffer = nil
+        buffer ||= ''
+
+        s = @socket.read length, buffer
+        frame = WebSocket::Frame::Incoming::Server.new :version => @handshake.version
+        frame << s
+        frame.next.to_s
+      end
+
+      def readpartial length, buffer = nil
+        s = @socket.readpartial length, buffer
+        frame = WebSocket::Frame::Incoming::Server.new :version => @handshake.version
+        frame << s
+        frame.next.to_s
+      end
+
+      def release_ownership type
+        @socket.release_ownership type
+      end
+
+      def to_io
+        @socket
+      end
+
+      def wait_readable
+        @socket.wait_readable
+      end
+
+      def wait_writable
+        @socket.wait_writable
+      end
+
+      def write s
+        frame = WebSocket::Frame::Outgoing::Server.new :version => @handshake.version, :data => s, :type => :text
+        @socket.write frame.to_s
+      end
+
+      def write_nonblock s
+        frame = WebSocket::Frame::Outgoing::Server.new :version => @handshake.version, :data => s, :type => :text
+        @socket.write_nonblock frame.to_s
+      end
+
+      def << s
+        frame = WebSocket::Frame::Outgoing::Server.new :version => @handshake.version, :data => s, :type => :text
+        @socket << frame.to_s
+      end
+    end
+
+    def initialize hostname, port
+      @server = Celluloid::IO::TCPServer.new hostname, port
+    end
+
+    def accept
+      AcceptedSocket.new(@server.accept).connect
+    end
+
+    def accept_nonblock
+      AcceptedSocket.new(@server.accept_nonblock).connect
+    end
+
+    def to_io
+      @server
+    end
+
+    def evented?
+      @server.evented?
+    end
+  end
+end

data/lib/WEBSocket/Celluloid/socket.rb

@@ -0,0 +1,85 @@
+module WEBSocket
+  class Socket
+    extend Forwardable
+    attr_reader :status
+
+    def_delegators :@socket, :close, :closed?
+    def_delegators :@socket, :addr, :peeraddr, :setsockopt
+
+    def acquire_ownership type
+      @socket.acquire_ownership type
+    end
+
+    def connect host, port
+      @handshake = WebSocket::Handshake::Client.new :url => "ws://#{host}:#{port}"
+      @socket.write @handshake.to_s
+      msg = @socket.readpartial 4096
+      @handshake << msg
+      @status = :connected
+    end
+
+    def evented?
+      @socket.evented?
+    end
+
+    def initialize rhost, rport, lhost = nil, lport = nil
+      @status = :disconnected
+      @socket = Celluloid::IO::TCPSocket.new rhost, rport, lhost, lport
+      connect rhost, rport
+    end
+
+    def read length = nil, buffer = nil
+      s = @socket.read length, buffer
+      frame = WebSocket::Frame::Incoming::Client.new :version => @handshake.version
+      frame << s
+      frame.to_s
+    end
+
+    def read_nonblock length, buffer = nil
+      buffer ||= ''
+
+      @socket.read_nonblock length, buffer
+      frame = WebSocket::Frame::Incoming::Client.new :version => @handshake.version
+      frame << buffer
+      frame.to_s
+    end
+
+    def readpartial length, buffer = nil
+      s = @socket.readpartial length, buffer
+      frame = WebSocket::Frame::Incoming::Client.new :version => @handshake.version
+      frame << s
+      frame.to_s
+    end
+
+    def release_ownership type
+      @socket.release_ownership type
+    end
+
+    def to_io
+      @socket
+    end
+
+    def wait_readable
+      @socket.wait_readable
+    end
+
+    def wait_writable
+      @socket.wait_writable
+    end
+
+    def write s
+      frame = WebSocket::Frame::Outgoing::Client.new :version => @handshake.version, :data => s, :type => :text
+      @socket.write frame.to_s
+    end
+
+    def write_nonblock s
+      frame = WebSocket::Frame::Outgoing::Client.new :version => @handshake.version, :data => s, :type => :text
+      @socket.write_nonblock frame.to_s
+    end
+
+    def << s
+      frame = WebSocket::Frame::Outgoing::Client.new :version => @handshake.version, :data => s, :type => :text
+      @socket << frame.to_s
+    end
+  end
+end

data/lib/WEBSocket/Standard/server.rb

@@ -0,0 +1,32 @@
+module WEBSocket
+  class Server
+
+    if defined? Celluloid::IO
+      UnderlyingServer = Celluloid::IO::TCPServer
+    else
+      UnderlyingServer = TCPSocket
+    end
+    
+    def initialize hostname, port
+      @server = UnderlyingServer.new hostname, port
+    end
+
+    def accept
+      WEBSocket::Socket.from_underlying_socket @server.accept
+    end
+
+    def accept_nonblock
+      Celluloid::IO::TCPSocket.from_ruby_socket @server.accept_nonblock
+    end
+
+    def to_io
+      @server
+    end
+
+    # Are we inside a Celluloid ::IO actor?
+    def evented?
+      actor = Thread.current[:actor]
+      actor && actor.mailbox.is_a?(Celluloid::IO::Mailbox)
+    end
+  end
+end

data/lib/WEBSocket/Standard/socket.rb

@@ -0,0 +1,74 @@
+module WEBSocket
+  class Socket
+    attr_reader :status
+
+    def self.from_underlying_socket socket
+    end
+
+    def acquire_ownership type
+      @socket.acquire_ownership type
+    end
+
+    def close
+      @socket.close
+    end
+
+    def connect host, port
+      @handshake = WebSocket::Handshake::Client.new :url => "ws://#{host}:#{port}"
+      @socket.write @handshake.to_s
+      msg = @socket.readpartial 4096
+      @handshake << msg
+      @status = :connected
+    end
+
+    def evented?
+      @socket.evented?
+    end
+
+    def initialize rhost, rport, lhost = nil, lport = nil
+      @status = :disconnected
+      @socket = TCPSocket.new rhost, rport, lhost, lport
+      connect rhost, rport
+    end
+
+    def read length = nil, buffer = nil
+      s = @socket.read length, buffer
+      frame = WebSocket::Frame::Incoming::Client.new :version => @handshake.version
+      frame << s
+      frame.to_s
+    end
+
+    def readpartial length, buffer = nil
+      s = @socket.readpartial length, buffer
+      frame = WebSocket::Frame::Incoming::Client.new :version => @handshake.version
+      frame << s
+      frame.to_s
+    end
+
+    def release_ownership type
+      @socket.release_ownership type
+    end
+
+    def to_io
+      @socket
+    end
+
+    def wait_readable
+      @socket.wait_readable
+    end
+
+    def wait_writable
+      @socket.wait_writable
+    end
+
+    def write s
+      frame = WebSocket::Frame::Outgoing::Client.new :version => @handshake.version, :data => s, :type => :text
+      @socket.write frame.to_s
+    end
+
+    def << s
+      frame = WebSocket::Frame::Outgoing::Client.new :version => @handshake.version, :data => s, :type => :text
+      @socket << frame.to_s
+    end
+  end
+end

data/lib/WEBSocket/server.rb

@@ -0,0 +1,6 @@
+if defined? Celluloid::IO
+  require 'WEBSocket/Celluloid/server'
+else
+  require 'socket'
+  require 'WEBSocket/Standard/server'
+end

data/lib/WEBSocket/socket.rb

@@ -0,0 +1,6 @@
+if defined? Celluloid::IO
+  require 'WEBSocket/Celluloid/socket'
+else
+  require 'socket'
+  require 'WEBSocket/Standard/socket'
+end

data/lib/WEBSocket/version.rb

@@ -0,0 +1,4 @@
+module WEBSocket
+  VERSION = "0.0.1"
+  DATE = Time.now.to_s.split[0]
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: WEBSocket
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthieu "Ezveus" Ciappara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+description: ! 'Establish a websocket communication using Ruby standard sockets or
+  Celluloid::IO sockets if required.
+
+'
+email:
+- ciappam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- WEBSocket.gemspec
+- lib/WEBSocket.rb
+- lib/WEBSocket/Celluloid/server.rb
+- lib/WEBSocket/Celluloid/socket.rb
+- lib/WEBSocket/Standard/server.rb
+- lib/WEBSocket/Standard/socket.rb
+- lib/WEBSocket/server.rb
+- lib/WEBSocket/socket.rb
+- lib/WEBSocket/version.rb
+homepage: https://github.com/Ezveus/ruby-websocket
+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.24
+signing_key: 
+specification_version: 3
+summary: Establish a websocket communication
+test_files: []
+has_rdoc: