shaft 0.5.0

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 shaft.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sagie Maoz
+
+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,67 @@
+# Shaft - right on.
+
+<pre>
+ $$$$$$\  $$\   $$\  $$$$$$\  $$$$$$$$\ $$$$$$$$\
+$$  __$$\ $$ |  $$ |$$  __$$\ $$  _____|\__$$  __|
+$$ /  \__|$$ |  $$ |$$ /  $$ |$$ |         $$ |
+\$$$$$$\  $$$$$$$$ |$$$$$$$$ |$$$$$\       $$ |
+ \____$$\ $$  __$$ |$$  __$$ |$$  __|      $$ |
+$$\   $$ |$$ |  $$ |$$ |  $$ |$$ |         $$ |
+\$$$$$$  |$$ |  $$ |$$ |  $$ |$$ |         $$ |
+ \______/ \__|  \__|\__|  \__|\__|         \__|
+</pre>
+
+An SSH tunnel assistant for the command line.
+
+
+## Installation
+
+As easy as:
+
+    $ gem install shaft
+
+## Usage
+
+Your tunnel configurations need to be stored as
+[YAML](http://www.yaml.org) files on your `~/.shaft/` dir.
+
+See 'Configuration' for instructions on how to format these
+files.
+
+* Use `shaft all` to get a list of all available tunnels.
+* Use `shaft list` to see which tunnels are currently active.
+  - You could use the `--short` option to get only the names
+    of those lines (this could be useful to insert into your
+    shell prompt. Just saying).
+* `shaft start [NAME]` would start the tunnel of the same name.
+* `shaft stop [NAME]` would stop the tunnel of the given name.
+
+## Configuration
+
+Each SSH tunnel you want to have configured needs to be defined
+in YAML format and stored in `~/.shaft/name.yml`, where `name`
+is the tunnel name that would be used for `shaft`.
+
+An example configuration would be:
+
+    port: 22
+    username: user
+    host: remote-host
+    bind:
+      client-port: 9999
+      host: host
+      host-port: 8888
+
+
+Starting the tunnel defined in this example would be equivalent
+to running:
+
+      $ ssh -N -p 22 user@remote-host -L 9999:host:8888
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/TODO

@@ -0,0 +1,2 @@
+1. Write tests.
+2. Verify killing of ssh process after 'stop' task.

data/bin/shaft

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+
+SHAFT_DIR = File.join(Dir.home, ".shaft")
+
+require 'rubygems'
+require 'thor'
+require 'yaml'
+
+class ShaftCLI < Thor
+  include Thor::Actions
+
+  map "-h" => :help
+  map "-l" => :list
+
+  desc "list", "Lists active tunnels"
+  method_options %w( short -s ) => :boolean
+  def list
+    active = get_active
+    unless active.empty?
+      if options[:short]
+        say active.keys.join(",")
+      else
+        say "Listing currently active tunnels:"
+        print_table active
+      end
+    else
+      say "No tunnels are currently active." unless options[:short]
+    end
+  end
+
+  desc "all", "Lists all available tunnels"
+  def all
+    say "Listing all available tunnels:"
+    tunnels = Dir["#{SHAFT_DIR}/*.yml"].map { |f| File.basename(f, ".yml") }
+    print_in_columns tunnels
+  end
+
+  desc "start [NAME]", "Starts a tunnel"
+  method_options :name => :string
+  def start(name)
+    active = get_active
+    if active.has_key? name
+      say "Error: tunnel '#{name}' already active!"
+    else
+      c = read_yaml("#{name}.yml")
+      unless c.nil?
+        begin
+          port = c['port']
+          bind = "#{c['bind']['client-port']}:#{c['bind']['host']}:#{c['bind']['host-port']}"
+          host = "#{c['username']}@#{c['host']}"
+        rescue NoMethodError
+          error "Tunnel file for '#{name}' appears to be invalid!"
+          return
+        end
+
+        say "Starting tunnel '#{name}'..."
+        pid = Process.spawn("ssh -N -p #{port} #{host} -L #{bind}")
+        Process.detach pid
+        say "Started with pid #{pid}."
+
+        active[name] = pid
+        set_active(active)
+      else
+        error "Tunnel '#{name}' file not found!"
+      end
+    end
+  end
+
+  desc "stop [NAME]", "Stops a tunnel"
+  method_options :name => :string
+  def stop(name)
+    active = get_active
+    if active.has_key? name
+      say "Stopping tunnel '#{name}' at pid #{active[name]}..."
+      Process.kill "INT", active[name]
+      say "Stopped."
+
+      #TODO verify killing?
+
+      active.delete(name)
+      set_active(active)
+    else
+      error "Tunnel '#{name}' does not seem to be active!"
+    end
+  end
+
+  private
+  def read_yaml(filename)
+    path = File.join(SHAFT_DIR, filename)
+    YAML::load(File.open(path)) if File.exist?(path)
+  end
+
+  def get_active
+    active = read_yaml(".active")
+    if active.nil?
+      active = {}
+      set_active(active)
+    end
+    active
+  end
+
+  def set_active(active)
+    unless File.exist?(SHAFT_DIR) and File.directory?(SHAFT_DIR)
+      Dir.mkdir(SHAFT_DIR)
+    end
+
+    File.open(File.join(SHAFT_DIR, '.active'), 'w') { |f|
+      f.write(active.to_yaml)
+    }
+  end
+
+end
+
+ShaftCLI.start

data/lib/shaft/version.rb

@@ -0,0 +1,3 @@
+module Shaft
+  VERSION = "0.5.0"
+end

data/lib/shaft.rb

@@ -0,0 +1,5 @@
+require "shaft/version"
+
+module Shaft
+  # Your code goes here...
+end

data/shaft.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/shaft/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Sagie Maoz"]
+  gem.email         = ["sagie2maoz.info"]
+  gem.description   = %q{SSH tunnels manager}
+  gem.summary       = %q{An SSH tunnel assistant for the command line.}
+  gem.homepage      = "http://github.com/n0nick/shaft"
+
+  gem.add_dependency "thor"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "shaft"
+  gem.require_paths = ["lib"]
+  gem.version       = Shaft::VERSION
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: shaft
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Sagie Maoz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SSH tunnels manager
+email:
+- sagie2maoz.info
+executables:
+- shaft
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO
+- bin/shaft
+- lib/shaft.rb
+- lib/shaft/version.rb
+- shaft.gemspec
+homepage: http://github.com/n0nick/shaft
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: An SSH tunnel assistant for the command line.
+test_files: []