tubesock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b47058bf07fdf65340f9ee65ee32cdc39a28b5b
+  data.tar.gz: cb112f9c8bf14fab05f7b100b7b8cb8ff11cd003
+SHA512:
+  metadata.gz: 41b5e67e9984af275cd40f36277f866495fabd0da6fb1b4a7258ef493d1f3b9562e09e1c2e494877a99af36ad0ea7ef4c79e646a6f79279372e419abec06430c
+  data.tar.gz: 0284696e54e55969f29e6e6ac4350bbda3b5fc0d42ad6f6af35804d6bb85706b593f37c3fe364b5ce55eda0ae654d2535a04f5573d6bc24089139783cfdfe40f

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tubesock.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nick Gauthier
+
+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,79 @@
+# Tubesock
+
+Tubesock lets you use websockets from rack and rails 4+ by using Rack's new hijack interface to access the underlying socket connection.
+
+In contrast to other websocket libraries, Tubesock does not use a reactor (read: no eventmachine). Instead, it leverages Rails 4's new full-stack concurrency support. Note that this means you must use a concurrent server. We recommend Puma.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tubesock'
+# currently, the ability to setup a websocket from rack is only
+# available on my fork. If/when the PR is merged this will become a gem dependency
+gem 'websocket', github: "ngauthier/websocket-ruby", ref: "8fc3bbc8f336fb5ccac95b8707e8146e86a8002d"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tubesock
+
+## Usage
+
+### Rack
+
+To use Tubesock with rack, you need to hijack the rack environment and then return an asynchronous response. For example:
+
+```ruby
+def self.call(env)
+  if websocket?(env)
+    tubesock = hijack(env)
+    tubesock.listen
+    tubesock.onmessage do |message|
+      puts "Got #{message}"
+    end
+    [ -1, {}, [] ]
+  else
+    [404, {'Content-Type' => 'text/plain'}, ['Not Found']]
+  end
+end
+```
+
+NOTE: I have not gotten the above to work just yet with just puma or thin. For now, check out the rails example.
+
+### Rails 4+
+
+On Rails 4 there is a module you can use called `Tubesock::Hijack`. In a controller:
+
+```ruby
+class ChatController < ApplicationController
+  include Tubesock::Hijack
+
+  def chat
+    hijack do |tubesock|
+      tubesock.onopen do
+        tubesock.send_data message: "Hello, friend"
+      end
+
+      tubesock.onmessage do |data|
+        tubesock.send_data message: "You said: #{data[:message]}"
+      end
+    end
+  end
+end
+```
+
+For a full example, check out [Tubesock Example](http://github.com/ngauthier/tubesock-example).
+
+## 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/lib/tubesock.rb

@@ -0,0 +1,83 @@
+require "tubesock/version"
+require "tubesock/hijack" if defined?(Rails)
+
+class Tubesock
+  def initialize(socket, version)
+    @socket     = socket
+    @version    = version
+  end
+
+  def self.hijack(env)
+    env['rack.hijack'].call
+    socket = env['rack.hijack_io']
+
+    handshake = WebSocket::Handshake::Server.new
+    handshake.headers["sec-websocket-version"]    = env["HTTP_SEC_WEBSOCKET_VERSION"]
+    handshake.headers["sec-websocket-draft"]      = env["HTTP_SEC_WEBSOCKET_DRAFT"]
+    handshake.headers["sec-websocket-key"]        = env["HTTP_SEC_WEBSOCKET_KEY"]
+    handshake.headers["sec-websocket-extensions"] = env["HTTP_SEC_WEBSOCKET_EXTENSIONS"]
+    handshake.headers["host"]                     = env["HTTP_HOST"]
+    handshake.path                                = env["REQUEST_PATH"]
+    handshake.query                               = env["QUERY_STRING"]
+    handshake.set_version
+
+    socket.write handshake.to_s
+
+    self.new socket, handshake.version
+  end
+
+  def self.websocket?(env)
+    env['REQUEST_METHOD'] == 'GET' and
+    env['HTTP_CONNECTION'] and
+    env['HTTP_CONNECTION'].split(/\s*,\s*/).include?('Upgrade') and
+    env['HTTP_UPGRADE'].downcase == 'websocket'
+  end
+
+  def send_data data, type = :text
+    frame = WebSocket::Frame::Outgoing::Server.new(version: @version, data: JSON.dump(data), type: type)
+    @socket.write frame.to_s
+  rescue IOError
+    close
+  end
+
+  def onopen(&block)
+    @openhandler = block
+  end
+
+  def onmessage(&block)
+    @messagehandler = block
+  end
+
+  def onclose(&block)
+    @closehandler = block
+  end
+
+  def listen
+    Thread.new do
+      Thread.current.abort_on_exception = true
+      framebuffer = WebSocket::Frame::Incoming::Server.new(version: @version)
+      running = true
+      while running
+        data, addrinfo = @socket.recvfrom(2000)
+        running = false if data == ""
+        framebuffer << data
+        while frame = framebuffer.next
+          data = frame.data
+          if data == ""
+            running = false
+          else
+            @messagehandler.call(HashWithIndifferentAccess.new(JSON.load(data))) if @messagehandler
+          end
+        end
+      end
+      @closehandler.call if @closehandler
+      @socket.close
+    end
+    @openhandler.call if @openhandler
+  end
+
+  def close
+    @socket.close if @socket.open?
+    @closehandler.call
+  end
+end

data/lib/tubesock/hijack.rb

@@ -0,0 +1,22 @@
+require 'active_support/concern'
+class Tubesock
+  module Hijack
+    extend ActiveSupport::Concern
+
+    included do
+      def hijack
+        if Tubesock.websocket?(env)
+          rocket = Tubesock.hijack(env)
+          yield rocket
+          rocket.listen
+          render text: nil, status: -1
+        else
+          render text: "Not found", status: :not_found
+        end
+      end
+    end
+
+    module ClassMethods
+    end
+  end
+end

data/lib/tubesock/version.rb

@@ -0,0 +1,3 @@
+class Tubesock
+  VERSION = "0.0.1"
+end

data/tubesock.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tubesock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tubesock"
+  spec.version       = Tubesock::VERSION
+  spec.authors       = ["Nick Gauthier"]
+  spec.email         = ["ngauthier@gmail.com"]
+  spec.description   = %q{Websocket interface on Rack Hijack w/ Rails support}
+  spec.summary       = %q{Handle websocket connections via Rack and Rails 4 using concurrency}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", "> 1.5.0"
+  spec.add_dependency "websocket" # TODO specify the new version when my PR is merged
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: tubesock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nick Gauthier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 1.5.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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Websocket interface on Rack Hijack w/ Rails support
+email:
+- ngauthier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tubesock.rb
+- lib/tubesock/hijack.rb
+- lib/tubesock/version.rb
+- tubesock.gemspec
+homepage: ''
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Handle websocket connections via Rack and Rails 4 using concurrency
+test_files: []