tubesock 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e34c2f3cd416319f09063d1420a92bb4de54f41
-  data.tar.gz: 35232dc37e37a9abd7b2595d4eeb8b9e9b252b39
+  metadata.gz: 0a5fc91c6e49797a1595e75ac1fa8425259370a3
+  data.tar.gz: 3af86ddcbe0fe0cf80aac51d25f27420ca2bb444
 SHA512:
-  metadata.gz: 81501d0966fd116753dfe71231626c3cda459672fef63bde5f12a0df305ed91d89fafba1179a29ea825562aa6052bf40c94d0e72c568e46b3bdba2d5daa417f2
-  data.tar.gz: 5a06e190adfd2967405e22af868f0967d671b20613c30682fa4bf3d925579e9f49df83d582c4729f640c61cdde314e86d86f309f726d0891e4370f3f36cbab87
+  metadata.gz: b6fa82ff09d335de5942b2ee415a328c15a40ba579f82f1f1293dd6c40de9edb100eb633384d1debb7cde05c017ff69239e9ceff8da37bf8f8c583a9338757aa
+  data.tar.gz: 3b5050954b14fafc27df74ddaabb5a34f3e8399db95e3d256f5b71c14385f803a28a552a026fd679c2c3ec5e43408b9b0c3881806343e1dd2cc5129edf9d3f1f

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in tubesock.gemspec
+gem "websocket", github: "imanel/websocket-ruby", ref: "49cc8e00eca912726c9980ccb6c927afd718c2de"
 gemspec

data/README.md

@@ -1,5 +1,7 @@
 # Tubesock
 
+[![Build Status](https://travis-ci.org/ngauthier/tubesock.png)](https://travis-ci.org/ngauthier/tubesock) [![Code Climate](https://codeclimate.com/github/ngauthier/tubesock.png)](https://codeclimate.com/github/ngauthier/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.
@@ -12,7 +14,7 @@ Add this line to your application's Gemfile:
 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"
+gem 'websocket', github: "ngauthier/websocket-ruby"
 ```
 
 And then execute:

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task default: :test

data/lib/tubesock.rb

@@ -1,6 +1,9 @@
 require "tubesock/version"
-require "tubesock/hijack" if defined?(Rails)
+require "tubesock/hijack" if defined?(ActiveSupport)
+require "websocket"
 
+# Easily interact with WebSocket connections over Rack.
+# TODO: Example with pure Rack
 class Tubesock
   class HijackNotAvailable < RuntimeError
   end
@@ -30,15 +33,12 @@ class Tubesock
     end
   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)
+    frame = WebSocket::Frame::Outgoing::Server.new(
+      version: @version,
+      data: JSON.dump(data),
+      type: type
+    )
     @socket.write frame.to_s
   rescue IOError
     close
@@ -59,24 +59,26 @@ class Tubesock
   def listen
     Thread.new do
       Thread.current.abort_on_exception = true
-      framebuffer = WebSocket::Frame::Incoming::Server.new(version: @version)
-      running = true
       @open_handlers.each(&:call)
-      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
-            @message_handlers.each{|h| h.call(HashWithIndifferentAccess.new(JSON.load(data))) }
-          end
-        end
+      each_frame do |data|
+        @message_handlers.each{|h| h.call(JSON.load(data)) }
       end
       @close_handlers.each(&:call)
       @socket.close
     end
   end
+
+  private
+  def each_frame
+    framebuffer = WebSocket::Frame::Incoming::Server.new(version: @version)
+    while !@socket.closed?
+      data, addrinfo = @socket.recvfrom(2000)
+      break if data.empty?
+      framebuffer << data
+      while frame = framebuffer.next
+        return if frame.type == :close
+        yield frame.data
+      end
+    end
+  end
 end

data/lib/tubesock/hijack.rb

@@ -1,25 +1,39 @@
 require 'active_support/concern'
-class Tubesock
-  module Hijack
-    extend ActiveSupport::Concern
+# Interact with WebSocket connections in rails.
+# Example:
+#   # The widget controller's `show` lets you edit a widget in
+#   # real time. The websocket frames from the client should be in JSON, for
+#   # example:
+#   #    socket.send(JSON.stringify({name: "foo"}));
+#   class WidgetController < ApplicationController
+#     include Tubesock::Hijack
+#     def show
+#       widget = Widget.find params[:id]
+#       hijack do |tubesock|
+#         tubesock.onopen do
+#           widget.update_attribute :editing, true
+#         end
+#         tubesock.onmessage do |message|
+#           widget.update_attribute :name, message["name"]
+#         end
+#         tubesock.onclose do
+#           widget.update_attribute :editing, true
+#         end
+#       end
+#     end
+#   end
+module Tubesock::Hijack
+  extend ActiveSupport::Concern
 
-    included do
-      def hijack
-        if Tubesock.websocket?(env)
-          sock = Tubesock.hijack(env)
-          yield sock
-          sock.onclose do
-            ActiveRecord::Base.clear_active_connections!
-          end
-          sock.listen
-          render text: nil, status: -1
-        else
-          render text: "Not found", status: :not_found
-        end
+  included do
+    def hijack
+      sock = Tubesock.hijack(env)
+      yield sock
+      sock.onclose do
+        ActiveRecord::Base.clear_active_connections! if defined? ActiveRecord
       end
-    end
-
-    module ClassMethods
+      sock.listen
+      render text: nil, status: -1
     end
   end
 end

data/lib/tubesock/version.rb

@@ -1,3 +1,3 @@
 class Tubesock
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/test/test_helper.rb

@@ -0,0 +1,83 @@
+require 'bundler/setup'
+require 'simplecov'
+SimpleCov.start
+require 'active_support'
+require 'minitest/autorun'
+require 'webrick'
+require 'stringio'
+require 'tubesock'
+require 'json'
+
+class Tubesock::TestCase < Minitest::Unit::TestCase
+end
+
+# Abstract away frames and sockets so that
+# tests can focus on message interaction
+class Tubesock::TestCase::TestInteraction
+  def initialize
+    @client_socket, @server_socket = UNIXSocket.pair
+  end
+
+  def handshake
+    @handshake ||= WebSocket::Handshake::Client.new(:url => 'ws://example.com')
+  end
+
+  def version
+    handshake.version
+  end
+
+  def env
+    request = WEBrick::HTTPRequest.new( :ServerSoftware => "" )
+    request.parse(StringIO.new(handshake.to_s))
+    rest = handshake.to_s.slice((request.to_s.length..-1))
+
+    request.meta_vars.merge(
+      "rack.input" => StringIO.new(rest),
+      "rack.hijack" => proc {},
+      "rack.hijack_io" => @server_socket
+    )
+  end
+
+  def write_raw(message)
+    @client_socket << message
+  end
+
+  def write(message)
+    write_raw WebSocket::Frame::Outgoing::Client.new(
+      version: version,
+      data:    JSON.dump(message),
+      type:    :text
+    ).to_s
+  end
+
+  def read
+    framebuffer = WebSocket::Frame::Incoming::Client.new(version: version)
+    data, addrinfo = @client_socket.recvfrom(2000)
+    framebuffer << data
+    JSON.load(framebuffer.next.data)
+  end
+
+  def join
+    @thread.join
+  end
+
+  def close
+    @client_socket.close
+    join
+  end
+
+  def tubesock
+    tubesock = Tubesock.hijack(env)
+    yield tubesock
+    @thread = tubesock.listen
+    @client_socket.recvfrom 2000 # flush the handshake
+    tubesock
+  end
+end
+
+class MockProc
+  attr_reader :called
+  def to_proc
+    proc { @called = true }
+  end
+end

data/test/tubesock_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+# Force autoloading of classes
+WebSocket::Frame::Incoming::Client
+WebSocket::Frame::Outgoing::Client
+WebSocket::Frame::Incoming::Server
+WebSocket::Frame::Outgoing::Server
+
+class TubesockTest < Tubesock::TestCase
+
+  def test_raise_exception_when_hijack_is_not_available
+    -> {
+      Tubesock.hijack({})
+    }.must_raise Tubesock::HijackNotAvailable
+  end
+
+  def test_hijack
+    interaction = TestInteraction.new
+
+    opened = MockProc.new
+    closed = MockProc.new
+
+    interaction.tubesock do |tubesock|
+      tubesock.onopen  &opened
+      tubesock.onclose &closed
+
+      tubesock.onmessage do |message|
+        tubesock.send_data message: "Hello #{message["name"]}"
+      end
+    end
+
+    interaction.write name: "Nick"
+    data = interaction.read
+    data["message"].must_equal "Hello Nick"
+    interaction.close
+
+    opened.called.must_equal true
+    closed.called.must_equal true
+  end
+
+  def test_close_on_close_frame
+    interaction = TestInteraction.new
+
+    closed = MockProc.new
+
+    interaction.tubesock do |tubesock|
+      tubesock.onclose &closed
+    end
+
+    # That's what Firefox sends when disconnecting.
+    interaction.write_raw "\x88\x82\xA3\x95\xD5\xB1\xA0|".force_encoding('binary')
+
+    interaction.join
+
+    closed.called.must_equal true
+  end
+end

data/tubesock.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.homepage      = "http://github.com/ngauthier/tubesock"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -23,4 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 4.7.3"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "activesupport"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tubesock
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Nick Gauthier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-21 00:00:00.000000000 Z
+date: 2013-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -66,6 +66,48 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: activesupport
+  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
@@ -74,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -81,8 +124,10 @@ files:
 - lib/tubesock.rb
 - lib/tubesock/hijack.rb
 - lib/tubesock/version.rb
+- test/test_helper.rb
+- test/tubesock_test.rb
 - tubesock.gemspec
-homepage: ''
+homepage: http://github.com/ngauthier/tubesock
 licenses:
 - MIT
 metadata: {}
@@ -106,4 +151,6 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Handle websocket connections via Rack and Rails 4 using concurrency
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/tubesock_test.rb