pairkit 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Gabe Hollombe
+
+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.rdoc

@@ -0,0 +1,19 @@
+= pairkit
+
+Description goes here.
+
+== Contributing to pairkit
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Gabe Hollombe. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "pairkit"
+  gem.homepage = "http://pairkit.com"
+  gem.license = "MIT"
+  gem.summary = %Q{Share local ports over the Internet, even through NAT.}
+  gem.description = %Q{PairKit lets you temporarily expose any ports, on your local computer, to someone else on the Internet. This makes it great for sharing your local web server with a friend, or letting a buddy ssh into your box to pair with you on some code. PairKit uses SSH to set up reverse tunnels (one per exposed port) to your computer through a public server.}
+  gem.email = "gabe@avantbard.com"
+  gem.authors = ["Gabe Hollombe"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pairkit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/pairkit

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "bundler/setup"
+Bundler.require(:default)
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'lib/ssh_keys'
+
+J = MultiJson
+
+SERVER_HOST = "pairkit.com"
+SERVER_WEB = "http://#{SERVER_HOST}:80"
+SERVER_SSH_USERNAME = 'pairkit'
+
+
+class Pair < Thor
+  desc "claim_invite_code", "claim an invite code"
+  method_option :invite_code, :aliases => "-c", :desc => "Your invite code", :type => :string
+  def claim_invite_code
+    public_key = get_or_generate_ssh_key()
+    claim_response = RestClient.get(SERVER_WEB + "/claim_invite_code", :params => {:invite_code => options[:invite_code], :public_key => public_key})
+    puts claim_response
+  end
+
+  desc 'share [PORTS]', 'share some ports'
+  def share(*ports)
+    public_key = get_or_generate_ssh_key()
+    
+    # Register with the server
+    response = RestClient.post(SERVER_WEB + "/share",
+      :public_key => public_key,
+      :ports => ports)
+
+    share_result = J.load(response, :symbolize_keys => true)
+    puts "Share result: #{share_result}"
+
+    # Collect all the remote:local port forward pairs
+    reverse_tunnel_args = share_result[:remote_port_forwards].collect{ |remote_port, local_port| "-R #{remote_port}:localhost:#{local_port}" }
+
+    # Setup our reverse tunnel so the server forwards its remote ports to our local ports
+    setup_reverse_tunnel_cmd = "ssh -N #{reverse_tunnel_args.join(' ')} #{share_result[:ssh_user_name]}@#{share_result[:ssh_host]}"
+    puts "Running: #{setup_reverse_tunnel_cmd}"
+
+    pids = []
+    pids << Kernel.fork { `#{setup_reverse_tunnel_cmd}` }
+
+    # Let them know we're good to go
+    puts "OK! We're forwarding ports as long as you keep this process running."
+    puts "When you're ready to kill the port forwards, type Control+C."
+
+    # Wait for a Control+C to quit
+    trap("SIGINT") do 
+      # Cleanup our ssh forwards before we quit
+      pids.each {|pid| Process.kill("HUP", pid) }
+      puts "Thank you, come again! =-)"
+      exit!
+    end
+    cmd = nil
+    while cmd != "quit" do
+      cmd = STDIN.gets
+    end
+  end
+end
+
+Pair.start

data/lib/pairkit.rb

@@ -0,0 +1 @@
+#TODO encapsulate client executable code better and move most of it in here. And tests? =-)

data/lib/ssh_keys.rb

@@ -0,0 +1,63 @@
+# ----------------------------------------
+#
+# Thank you, Heroku gem, for nearly all of this!
+#
+# ----------------------------------------
+
+def get_or_generate_ssh_key
+  public_keys = Dir.glob("#{home_directory}/.ssh/*.pub").sort
+
+  case public_keys.length
+  when 0 then
+    puts "Could not find an existing public key."
+    puts "Let's generate one..."
+    puts "Generating new SSH public key."
+    generate_ssh_key("id_rsa")
+    get_key("#{home_directory}/.ssh/id_rsa.pub")
+  when 1 then
+    puts "Using existing public key: #{public_keys.first}"
+    get_key(public_keys.first)
+  else
+    puts "Found the following SSH public keys:"
+    public_keys.each_with_index do |key, index|
+      puts "#{index+1}) #{File.basename(key)}"
+    end
+    puts "Which would you like to use? (Enter number) "
+    choice = ask.to_i - 1
+    chosen = public_keys[choice]
+    if choice == -1 || chosen.nil?
+      error("Invalid choice.")
+    end
+    get_key(chosen)
+  end
+end
+
+def generate_ssh_key(keyfile)
+  ssh_dir = File.join(home_directory, ".ssh")
+  unless File.exists?(ssh_dir)
+    FileUtils.mkdir_p ssh_dir
+    File.chmod(0700, ssh_dir)
+  end
+  `ssh-keygen -t rsa -N "" -f \"#{home_directory}}/.ssh/#{keyfile}\" 2>&1`
+end
+
+def get_key(key)
+  File.read(key).chomp #strip trailing newline if present
+end
+
+def ask
+  $stdin.gets.to_s.strip
+end
+
+def error(message)
+  $stderr.puts(message)
+  exit(1)
+end
+
+def home_directory
+  running_on_windows? ? ENV['USERPROFILE'].gsub("\\","/") : ENV['HOME']
+end
+
+def running_on_windows?
+  RUBY_PLATFORM =~ /mswin32|mingw32/
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'pairkit'
+
+class Test::Unit::TestCase
+end

data/test/test_pairkit.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestPairkit < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: pairkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Gabe Hollombe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: PairKit lets you temporarily expose any ports, on your local computer,
+  to someone else on the Internet. This makes it great for sharing your local web
+  server with a friend, or letting a buddy ssh into your box to pair with you on some
+  code. PairKit uses SSH to set up reverse tunnels (one per exposed port) to your
+  computer through a public server.
+email: gabe@avantbard.com
+executables:
+- pairkit
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/pairkit
+- lib/pairkit.rb
+- lib/ssh_keys.rb
+- test/helper.rb
+- test/test_pairkit.rb
+homepage: http://pairkit.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2069664640876726119
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.22
+signing_key: 
+specification_version: 3
+summary: Share local ports over the Internet, even through NAT.
+test_files: []