tub 0.1.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use default@tub > /dev/null

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in genesis_graphs.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    tub (0.1.0)
+      activesupport
+      thin
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.2)
+    activesupport (3.0.3)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    daemons (1.1.0)
+    diff-lcs (1.1.2)
+    eventmachine (0.12.10)
+    rack (1.2.1)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    thin (1.2.7)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  autotest
+  rspec
+  thin
+  tub!

data/Readme.md

@@ -0,0 +1,48 @@
+Try It
+======
+
+Make a server
+
+    require 'tub'
+
+    class Echo < EM::Connection
+      def receive_data(data)
+        send_data(data)
+      end
+    end
+
+    app = lambda{|env| [200, {'Content-Type' => 'text/plain'}, ["Hello world!"]]}
+
+    Thin::Server.start('0.0.0.0', 1345, app, :backend => TUB::UpgradableTcpServer, :handler_on_upgrade => Echo)
+
+Connect to the server
+
+    telnet localhost 1345
+
+Speak HTTP
+
+    GET / HTTP/1.1
+    Host: example.com
+
+
+Now switch protocols
+
+    GET / HTTP/1.1
+    Host: example.com
+    Upgrade: Echo/1.0
+    Connection: Upgrade
+
+And then type anything you want, it'll echo back to you
+
+    Hello world
+    Hello world
+
+Have fun!
+
+
+TODO
+======
+* Make it actually care about what protocol the client requests and which you offer
+* Figure out rackup file
+* Show a sample app working in Heroku, with a sample client
+* Remove the Rack wrapper app and make it part of the example, but customizable, so you control when upgrade occurs

data/lib/tub.rb

@@ -0,0 +1,32 @@
+#--
+# Copyright (c) 2011 Tim Shadel
+#
+# 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.
+#++
+
+module ThinUpgradableBackend
+  ROOT = File.expand_path(File.dirname(__FILE__))
+end
+TUB = ThinUpgradableBackend
+
+require "#{TUB::ROOT}/tub/version"
+require "#{TUB::ROOT}/tub/upgradable_connection"
+require "#{TUB::ROOT}/tub/upgradable_tcp_server"
+require "#{TUB::ROOT}/tub/thin_persistent_101"

data/lib/tub/thin_persistent_101.rb

@@ -0,0 +1,35 @@
+#--
+# Copyright (c) 2011 Tim Shadel
+#
+# 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.
+#++
+
+module Thin
+
+  # This is a workaround, and should be removed as soon as Heroku deploys a Thin version
+  # that includes some version of https://github.com/macournoyer/thin/pull/32
+  class Response
+    alias :old_persistent? :persistent?
+    def persistent?
+      old_persistent? || (@status == 100 || @status == 101)
+    end
+  end
+
+end

data/lib/tub/upgradable_connection.rb

@@ -0,0 +1,56 @@
+#--
+# Copyright (c) 2011 Tim Shadel
+#
+# 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.
+#++
+
+require 'active_support/core_ext/class/attribute_accessors'
+require 'eventmachine'
+
+module TUB
+  class UpgradableConnection < EM::Connection
+    cattr_accessor :initial_handler_class
+    cattr_accessor :upgraded_handler_class
+    
+    attr_accessor :handler
+    
+    def post_init
+      @handler = UpgradableConnection.initial_handler_class.new @signature
+      @upgraded = false
+    end
+    
+    def receive_data(data)
+      @handler.receive_data(data)
+    end
+    
+    def unbind
+      @handler.unbind
+    end
+    
+    def upgrade!
+      return if @upgraded
+      @handler = UpgradableConnection.upgraded_handler_class.new @signature
+      @upgraded = true
+    end
+    
+  end
+end
+
+

data/lib/tub/upgradable_tcp_server.rb

@@ -0,0 +1,72 @@
+#--
+# Copyright (c) 2011 Tim Shadel
+#
+# 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.
+#++
+
+require 'thin'
+
+module TUB
+  
+  class UpgradeApp
+    def initialize(conn, app)
+      @conn = conn
+      @app = app
+    end
+
+    def call(env)
+      if env["HTTP_UPGRADE"]
+        @conn.upgrade!
+        [101, { "Upgrade" => env["HTTP_UPGRADE"], "Connection" => "Upgrade" }, []]
+      else
+        @app.call(env)
+      end
+    end
+  end
+  
+  class UpgradableTcpServer < Thin::Backends::TcpServer
+    attr_accessor :ssl
+    # Thin::Server assumes we'll have options
+    def initialize(host, port, options)
+      super(host, port)
+      UpgradableConnection.initial_handler_class = Thin::Connection
+      raise ":handler_on_upgrade must be provided" unless options[:handler_on_upgrade]
+      UpgradableConnection.upgraded_handler_class = options[:handler_on_upgrade]
+    end
+    
+    # Connect the server
+    def connect
+      @signature = EventMachine.start_server(@host, @port, UpgradableConnection, &method(:initialize_connection))
+    end
+
+    protected
+      # Initialize the HTTP handler when the connection is first created.
+      def initialize_connection(connection)
+        connection.handler.backend                 = self
+        ourApp = UpgradeApp.new connection, @server.app
+        connection.handler.app                     = ourApp
+        connection.handler.comm_inactivity_timeout = @timeout
+        connection.handler.threaded                = @threaded
+        connection.handler.can_persist!
+        
+        @connections << connection.handler
+      end
+  end
+end

data/lib/tub/version.rb

@@ -0,0 +1,32 @@
+#--
+# Copyright (c) 2011 Tim Shadel
+#
+# 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.
+#++
+
+module ThinUpgradableBackend
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+        
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,79 @@
+require 'bundler'
+Bundler.setup
+
+require 'thin'
+require 'tub'
+
+unless Object.const_defined?(:DEFAULT_TEST_ADDRESS)
+  DEFAULT_TEST_ADDRESS = '0.0.0.0'
+  DEFAULT_TEST_PORT    = 3333
+end
+
+module Helpers
+
+  def start_server(address=DEFAULT_TEST_ADDRESS, port=DEFAULT_TEST_PORT, options={}, &app)
+    @server = Thin::Server.new(address, port, options, app)
+    # @server.ssl = options[:ssl]
+    @server.threaded = options[:threaded]
+    @server.timeout = 3
+    
+    @thread = Thread.new { @server.start }
+    if options[:wait_for_socket]
+      wait_for_socket(address, port)
+    else
+      # If we can't ping the address fallback to just wait for the server to run
+      sleep 1 until @server.running?
+    end
+  end
+  
+  def stop_server
+    @server.stop!
+    @thread.kill
+    sleep 0.5
+    raise "Reactor still running, wtf?" if EventMachine.reactor_running?
+  end
+  
+  def wait_for_socket(address=DEFAULT_TEST_ADDRESS, port=DEFAULT_TEST_PORT, timeout=5)
+    Timeout.timeout(timeout) do
+      loop do
+        begin
+          TCPSocket.new(address, port).close
+          return true
+        rescue
+        end
+      end
+    end
+  end
+
+
+  def send_data(data)
+    socket = TCPSocket.new(@server.host, @server.port)
+    socket.write data
+    out = socket.read
+    socket.close
+    out
+  end
+
+  def parse_response(response)
+    raw_headers, body = response.split("\r\n\r\n", 2)
+    raw_status, raw_headers = raw_headers.split("\r\n", 2)
+
+    status  = raw_status.match(%r{\AHTTP/1.1\s+(\d+)\b}).captures.first.to_i
+    headers = Hash[ *raw_headers.split("\r\n").map { |h| h.split(/:\s+/, 2) }.flatten ]
+
+    [ status, headers, body ]
+  end
+
+  def get(url)
+    Net::HTTP.get(URI.parse("http://#{@server.host}:#{@server.port}" + url))
+  end
+
+  def post(url, params={})
+    Net::HTTP.post_form(URI.parse("http://#{@server.host}:#{@server.port}" + url), params).body
+  end
+ 
+end
+
+RSpec.configure do |config|
+  config.include Helpers
+end

data/spec/upgradable_backend_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+class Echo < EM::Connection
+  def receive_data(data)
+    send_data(data)
+  end
+end
+
+
+describe TUB::UpgradableTcpServer do
+  before do
+    start_server DEFAULT_TEST_ADDRESS, DEFAULT_TEST_PORT, :backend => TUB::UpgradableTcpServer, :handler_on_upgrade => Echo do |env|
+      body = env.inspect + env['rack.input'].read
+      [200, { 'Content-Type' => 'text/html' }, body]
+    end
+  end
+  
+  it 'should serve HTTP from the Rack app' do
+    get('/?cthis').should include('cthis')
+  end
+  
+  it 'should switch from HTTP to Echo when requested' do
+    socket = TCPSocket.new(@server.host, @server.port)
+    socket.sync = true
+    request = "GET / HTTP/1.1\r\nHost: arst.com\r\nUpgrade: Echo/1.0\r\nConnection: Upgrade\r\n\r\n"
+
+    socket.print request
+    out = ''
+    selection = IO.select([socket], nil, nil, 0.3)
+    while selection && selection[0]
+      begin
+        line = socket.readline
+        out << line
+        selection = IO.select([socket], nil, nil, 0.3)
+      rescue => ex
+        STDERR.puts ex
+        break
+      end
+    end
+
+    status, headers, body = parse_response(out)
+    status.should == 101
+    headers['Upgrade'].should == 'Echo/1.0'
+    headers['Connection'].should == 'Upgrade'
+    
+    selection = IO.select(nil, [socket], nil, 1.5)
+
+    ["I am in ", " echo", "mode"].each do |e|
+      socket.puts(e)
+    end
+
+    selection = IO.select([socket], nil, nil, 0.3)
+    while selection && selection[0]
+      begin
+        line = socket.readline
+        out << line
+        selection = IO.select([socket], nil, nil, 0.3)
+      rescue => ex
+        STDERR.puts ex
+        break
+      end
+    end
+    out.should match("am")
+    out.should match("echo")
+    out.should match("mode")
+    
+    socket.close
+  end
+  
+  after do
+    stop_server
+  end
+end

data/tub.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tub/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tub"
+  s.version     = ThinUpgradableBackend::VERSION::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tim Shadel"]
+  s.email       = ["github@timshadel.com"]
+  s.homepage    = "http://github.com/timshadel/tub"
+  s.summary     = %q{Make a Thin backend that can serve Rack, then easily be upgraded to a completely different EM-based protocol.}
+  s.description = %q{The HTTP spec details a way to use HTTP/1.1 as a platform for transitioning to newer protocols by starting the conversation with HTTP/1.1. There are no restrictions on what that protocol can be.}
+
+  # s.rubyforge_project = "tub"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "autotest"
+  s.add_dependency "thin"
+  s.add_dependency "activesupport"
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: tub
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tim Shadel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thin
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: The HTTP spec details a way to use HTTP/1.1 as a platform for transitioning to newer protocols by starting the conversation with HTTP/1.1. There are no restrictions on what that protocol can be.
+email: 
+- github@timshadel.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Readme.md
+- lib/tub.rb
+- lib/tub/thin_persistent_101.rb
+- lib/tub/upgradable_connection.rb
+- lib/tub/upgradable_tcp_server.rb
+- lib/tub/version.rb
+- spec/spec_helper.rb
+- spec/upgradable_backend_spec.rb
+- tub.gemspec
+has_rdoc: true
+homepage: http://github.com/timshadel/tub
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Make a Thin backend that can serve Rack, then easily be upgraded to a completely different EM-based protocol.
+test_files: 
+- spec/spec_helper.rb
+- spec/upgradable_backend_spec.rb