zerg_support 0.0.1

data/CHANGELOG

@@ -0,0 +1 @@
+v0.0.1. Initial release. Support code for zerg* gem installation.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008 Victor Costan
+
+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/Manifest

@@ -0,0 +1,8 @@
+lib/zerg_support/gems.rb
+lib/zerg_support.rb
+test/test_gems.rb
+CHANGELOG
+LICENSE
+README
+Rakefile
+Manifest

data/README

@@ -0,0 +1,61 @@
+INSTALL
+-
+
+on server and local machine:
+
+`gem sources -a http://gems.github.com`
+
+`sudo gem install coderrr-rtunnel`
+
+If you don't have root access on server, you can use either the rtunnel_server_linux binary (only works with linux), or extract the .tar.gz and use `rtunnel_server.rb` (all function the same)
+
+USAGE
+-
+
+on server (myserver.com):
+
+`rtunnel_server`
+
+on your local machine:
+
+`rtunnel_client -c myserver.com -f 4000 -t 3000`
+
+This would reverse tunnel myserver.com:4000 to localhost:3000 so that if you had a web server running at port 3000 on your local machine, anyone on the internet could access it by going to http://myserver.com:4000
+
+**News**
+
+  * 0.3.6 released, new protocol
+  * created gem for easier installation
+  * 0.2.1 released, minor bugfix, cmdline options change
+  * 0.2.0 released, much simpler
+  * 0.1.2 released
+  * Created rtunnel_server binary for linux so you don't need Ruby installed on the host you want to reverse tunnel from
+  * 0.1.1 released
+  * Added default control port of 19050, no longer have to specify this on client or server unless you care to change it
+
+RTunnel?
+-
+
+This client/server allow you to reverse tunnel traffic.  Reverse tunneling is useful if you want to run a server behind a NAT and you do not have the ability use port forwarding.  The specific reason I created this program was to reduce the pain of Facebook App development on a crappy internet connection that drops often.  ssh -R was not cutting it.
+
+**How does reverse tunneling work?**
+
+  * tunnel\_client makes connection to tunnel\_server (through NAT)
+  * tunnel_server listens on port X
+  * internet_user connects to port X on tunnel server
+  * tunnel\_server uses existing connection to tunnel internet user's request back to tunnel\_client
+  * tunnel_client connects to local server on port Y
+  * tunnel_client tunnels internet users connection through to local server
+
+or:
+
+  * establish connection: tunnel\_client --NAT--> tunnel\_server
+  * reverse tunnel: internet\_user -> tunnel_server --(NAT)--> tunnel\_client -> server\_running\_behind\_nat
+
+**How is this different than normal tunneling?**
+
+With tunneling, usually your connections are made in the same direction you create the tunnel connection.  With reverse tunneling, you tunnel your connections the opposite direction of which you made the tunnel connection.  So you initiate the tunnel with A -> B, but connections are tunneled from B -> A.
+
+**Why not just use ssh -R?**
+
+The same thing can be achieved with ssh -R, why not just use it?  A lot of ssh servers don't have the GatewayPorts sshd option set up to allow you to reverse tunnel.  If you are not in control of the server and it is not setup correctly then you are SOL.  RTunnel does not require you are in control of the server.  ssh -R has other annoyances.  When your connection drops and you try to re-initiate the reverse tunnel sometimes you get an address already in use error because the old tunnel process is still laying around.  This requires you to kill the existing sshd process.  RTunnel does not have this problem.

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+gem 'echoe'
+require 'echoe'
+
+Echoe.new('zerg_support') do |p|
+  p.project = 'rails-pwnage' # rubyforge project
+  
+  p.author = 'Victor Costan'
+  p.email = 'victor@zergling.net'
+  p.summary = 'Support libraries used by the Zerg system.'
+  p.url = 'http://www.zergling.net'
+  
+  p.need_tar_gz = true
+  p.need_zip = true
+  p.rdoc_pattern = /^(lib|bin|tasks|ext)|^BUILD|^README|^CHANGELOG|^TODO|^LICENSE|^COPYING$/  
+end
+
+if $0 == __FILE__
+  Rake.application = Rake::Application.new
+  Rake.application.run
+end

data/lib/zerg_support.rb

@@ -0,0 +1,9 @@
+# :nodoc
+module Zerg
+end
+
+# TODO(victor): document this
+module Zerg::Support
+end
+
+require 'zerg_support/gems.rb'

data/lib/zerg_support/gems.rb

@@ -0,0 +1,36 @@
+# methods used in gem installation hooks
+module Zerg::Support::Gems
+  # called by ensure_on_path for Windows systems
+  def self.ensure_on_windows_path(bin_file)
+    # TODO(victor): test this; it's likely that a .bat will be needed instead
+    path = "/windows/#{File.basename bin_file}"
+    return if File.exists? path
+    FileUtils.ln_s(bin_file, path, :force)  
+  end
+  
+  # called by ensure_on_path for UNIX systems
+  def self.ensure_on_unix_path(bin_file)
+    path = "/usr/bin/#{File.basename bin_file}"
+    return if File.exists? path
+    # using a link so the gem can be updated and the link still works
+    FileUtils.ln_s(bin_file, path, :force)
+  end
+  
+  # ensures that bin_file can be invoked from a shell
+  def self.ensure_on_path(bin_script)
+    bin_file = File.expand_path(__FILE__ + '/../../../bin/rpwn')
+    # this is a cheat to get the binary in the right place on stubborn Debians
+    if RUBY_PLATFORM =~ /win/ and RUBY_PLATFORM !~ /darwin/
+      ensure_on_windows_path bin_file
+    else
+      ensure_on_unix_path bin_file
+    end
+  end
+  
+  # tricks rubygems into believeing that the extension compiled and worked out
+  def self.emulate_extension_install(extension_name)
+    File.open('Makefile', 'w') { |f| f.write "all:\n\ninstall:\n\n" }
+    File.open(extension_name + '.so', 'w') {}
+    File.open(extension_name + '.dll', 'w') {}
+  end
+end

data/test/test_gems.rb

@@ -0,0 +1,29 @@
+require 'digest/sha1'
+require 'test/unit'
+
+require 'zerg_support'
+
+class TestGems < Test::Unit::TestCase
+  def hash_gems_file
+    file_path = File.join(File.dirname(__FILE__),
+                          '../lib/zerg_support/gems.rb')
+    Digest::SHA1.hexdigest File.read(file_path)
+  end
+  
+  def test_source_is_manually_tested
+    golden_hash = 'f02b6c7852af883d60d4ec0c658928579e61f270'
+    source_hash = hash_gems_file
+    
+    assert_equal golden_hash, source_hash, <<END_MESSAGE
+lib/zerg_support/zerg_support.rb has changed
+
+You need to manually test the file, then replace golden_hash in this test.
+Manual testing plan:
+1. rake install this gem (zerg_support)
+2. install zerg
+3. validate that the installation does not crash and the binary gets symlinked
+in the correct place
+4. replace golden_hash with #{source_hash}
+END_MESSAGE
+  end
+end

data/zerg_support.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{zerg_support}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Victor Costan"]
+  s.date = %q{2008-11-12}
+  s.description = %q{Support libraries used by the Zerg system.}
+  s.email = %q{victor@zergling.net}
+  s.extra_rdoc_files = ["lib/zerg_support/gems.rb", "lib/zerg_support.rb", "CHANGELOG", "LICENSE", "README"]
+  s.files = ["lib/zerg_support/gems.rb", "lib/zerg_support.rb", "test/test_gems.rb", "CHANGELOG", "LICENSE", "README", "Rakefile", "Manifest", "zerg_support.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://www.zergling.net}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Zerg_support", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rails-pwnage}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Support libraries used by the Zerg system.}
+  s.test_files = ["test/test_gems.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: zerg_support
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Victor Costan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Support libraries used by the Zerg system.
+email: victor@zergling.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/zerg_support/gems.rb
+- lib/zerg_support.rb
+- CHANGELOG
+- LICENSE
+- README
+files: 
+- lib/zerg_support/gems.rb
+- lib/zerg_support.rb
+- test/test_gems.rb
+- CHANGELOG
+- LICENSE
+- README
+- Rakefile
+- Manifest
+- zerg_support.gemspec
+has_rdoc: true
+homepage: http://www.zergling.net
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Zerg_support
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: rails-pwnage
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Support libraries used by the Zerg system.
+test_files: 
+- test/test_gems.rb