shaft 0.6 → 0.7

data/README.md

@@ -38,22 +38,24 @@ files.
 
 ## 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`.
+The SSH tunnels configuration Shaft will use are all stored in
+a single YAML file under `~/.shaft`.
 
-An example configuration would be:
+Each tunnel is represented by a key defining its name, followed
+by an object describing all of the required parameters.
 
-    port: 22
-    username: user
-    host: remote-host
-    bind:
-      client-port: 9999
-      host: host
-      host-port: 8888
+An example configuration would be:
 
+    foobar:
+        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
+Calling Shaft with `$ shaft start foobar` would be equivalent
 to running:
 
       $ ssh -N -p 22 user@remote-host -L 9999:host:8888

data/bin/shaft

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
-SHAFT_DIR = File.join(Dir.home, ".shaft")
+SHAFT_CONFIG = File.join(Dir.home, ".shaft")
+SHAFT_ACTIVE = File.join(Dir.home, ".shaft.active")
 
 require 'rubygems'
 require 'thor'
@@ -10,11 +11,11 @@ class ShaftCLI < Thor
   include Thor::Actions
 
   map "-h" => :help
-  map "-l" => :list
+  map "-l" => :active
 
-  desc "list", "Lists active tunnels"
+  desc "active", "Lists active tunnels"
   method_options %w( short -s ) => :boolean
-  def list
+  def active
     active = get_active
     unless active.empty?
       if options[:short]
@@ -31,7 +32,7 @@ class ShaftCLI < Thor
   desc "all", "Lists all available tunnels"
   def all
     say "Listing all available tunnels:"
-    tunnels = Dir["#{SHAFT_DIR}/*.yml"].map { |f| File.basename(f, ".yml") }
+    tunnels = get_config.keys
     print_in_columns tunnels
   end
 
@@ -42,14 +43,20 @@ class ShaftCLI < Thor
     if active.has_key? name
       say "Error: tunnel '#{name}' already active!"
     else
-      c = read_yaml("#{name}.yml")
+      c = get_tunnel(name)
       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!"
+          error "Tunnel configuration for '#{name}' appears to be invalid!"
+          return
+        end
+
+        used = local_port_used?(c['bind']['client-port'])
+        if used
+          error "Local port #{port} is used by:\n#{used}"
           return
         end
 
@@ -61,7 +68,7 @@ class ShaftCLI < Thor
         active[name] = pid
         set_active(active)
       else
-        error "Tunnel '#{name}' file not found!"
+        error "Tunnel '#{name}' not found!"
       end
     end
   end
@@ -70,19 +77,25 @@ class ShaftCLI < Thor
   method_options :name => :string
   def stop(name)
     active = get_active
-    if active.has_key? name
+    if active.has_key?(name)
       say "Stopping tunnel '#{name}' at pid #{active[name]}..."
       begin
         Process.kill "INT", active[name]
-        say "Stopped."
       rescue Errno::ESRCH
         say "Tunnel wasn't active (zombie shaft item)."
       end
 
-      #TODO verify killing?
+      # verify killing
+      tunnel = get_tunnel(name)
+      if local_port_used?(tunnel['bind']['client-port'])
+        error "Could not stop tunnel process!"
+      else
+        say "Stopped."
 
-      active.delete(name)
-      set_active(active)
+        # set as inactive
+        active.delete(name)
+        set_active(active)
+      end
     else
       error "Tunnel '#{name}' does not seem to be active!"
     end
@@ -95,28 +108,42 @@ class ShaftCLI < Thor
   end
 
   private
-  def read_yaml(filename)
-    path = File.join(SHAFT_DIR, filename)
-    YAML::load(File.open(path)) if File.exist?(path)
+  def get_config
+    @config ||= read_yaml(SHAFT_CONFIG)
   end
 
   def get_active
-    active = read_yaml(".active")
-    if active.nil?
-      active = {}
-      set_active(active)
-    end
-    active
+    @active ||= read_yaml(SHAFT_ACTIVE)
+  end
+
+  def get_tunnel(name)
+    get_config[name] || nil
   end
 
   def set_active(active)
-    unless File.exist?(SHAFT_DIR) and File.directory?(SHAFT_DIR)
-      Dir.mkdir(SHAFT_DIR)
+    File.open(SHAFT_ACTIVE, 'w') { |out|
+      YAML.dump(active, out)
+    }
+  end
+
+  def read_yaml(file)
+    if File.directory?(SHAFT_CONFIG)
+      error "Shaft v0.7 and up uses a single-file config.\nConsult the Readme at http://git.io/Zs3viQ ."
+      {}
+    elsif File.exists?(file)
+      YAML::load(File.open(file))
+    else
+      {}
     end
+  end
 
-    File.open(File.join(SHAFT_DIR, '.active'), 'w') { |f|
-      f.write(active.to_yaml)
-    }
+  def local_port_used?(port)
+    usage = `lsof -n -i4TCP:#{port} | grep LISTEN`
+    if usage.length > 0
+      usage
+    else
+      false
+    end
   end
 
 end

data/lib/shaft/version.rb

@@ -1,3 +1,3 @@
 module Shaft
-  VERSION = "0.6"
+  VERSION = "0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaft
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-04 00:00:00.000000000 Z
+date: 2013-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -69,3 +69,4 @@ signing_key:
 specification_version: 3
 summary: An SSH tunnel assistant for the command line.
 test_files: []
+has_rdoc: