runssh 0.4.3 → 0.5.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    runssh (0.4.3)
+    runssh (0.5.0)
       highline (~> 1.6.1)
       trollop (~> 1.16.2)
 

data/README.rdoc

@@ -3,14 +3,13 @@ A CLI utility to bookmark ssh connections with hierarchy and run various
 ssh commands on these bookmarks. Supported operations are:
 
 * Login
+* Scp
 * Copy ssh key
 * Run remote command
 * Create local tunnel
 
-I am planning to add scp support as well.
-
-This requires you to have the _ssh_ binary in your path and optionally the
-<i>ssh-copy-id</i> binary (for copying ssh key).
+This requires you to have the _ssh_ and _scp_ binaries in your path and
+optionally the <i>ssh-copy-id</i> binary (for copying ssh key).
 
 == Installation
 You must have ruby[http://www.ruby-lang.org/] and
@@ -142,10 +141,16 @@ and there's no going back ...)
   the required option is not given.
 * Finally - proper zsh completion :)
 
-== TODO
-* Create a _proper_ zsh completion script.
-* Add scp capabilities.
-* Shell via gateway (connect to a firewall and from there open shell to the host).
-* Rename (or move) host definition
-* Maybe replace invoking ssh from the command line with some library.
+=== 0.4.3
+* Added missing options/arguments completions to the _shell_ subcommand.
+
+=== 0.5.0
+* Added scp support.
+
+== TODO for 1.0
+* Merge configurations.
+
+== TODO for later
+* Rename (or move) host definition.
 * Automatic deletion of empty groups.
+* Shell via gateway (connect to a firewall and from there open shell to the host).

data/completions/_runssh

@@ -12,14 +12,14 @@ _runssh() {
 (( $+funtions[_runssh_commands] )) ||
 _runssh_commands() {
   if (( CURRENT == 1 )); then
-    _describe -t commands 'runssh commands' "(shell add del update print import export cpid)" && ret=0
+    _describe -t commands 'runssh commands' "(shell scp add del update print import export cpid)" && ret=0
   else
     # Since we're using a syntax that clears $words we have to get
     # the custom config file (if given) somehow.
     [[ -n "$opt_args[-f]" ]] && runssh_config_file="-f $opt_args[-f]"
     subcommand=$words[1]
     case $subcommand in
-      shell|del|print|import|export|cpid)
+      shell|scp|del|print|import|export|cpid)
         _call_function ret _runssh_subcmd_$subcommand
         ;;
       add|update) # they have the same options
@@ -45,6 +45,17 @@ _runssh_subcmd_shell() {
     '*: :_runssh_path_completions'
 }
 
+(( $+functions[_runssh_subcmd_scp] )) ||
+_runssh_subcmd_scp() {
+  _arguments \
+    '(-L --login)'{-L,--login}'+[Override login]: :' \
+    '(-n --host-name)'{-n,--host-name}'+[host to connect to]: :' \
+    {\*-o,\*--option}'+[Ssh option]: :' \
+    '(-r --recurssive)'{-r,--recurssive}'[copy directories recurssively]' \
+    '(-l --limit)'{-l,--limit}'+[limit bandwidth in kbit/s]: :' \
+    '*: :_runssh_path_completions'
+}
+
 (( $+functions[_runssh_subcmd_cpid] )) ||
 _runssh_subcmd_cpid() {
   _arguments \

data/completions/runssh_comp.sh

@@ -13,7 +13,7 @@ function _runssh () {
     if [ ${COMP_CWORD} -gt $COM_POSITION ]; then
         options=$(${COMP_WORDS[@]:0:COMP_CWORD} ? 2>/dev/null)
     elif [ $COMP_CWORD -eq $COM_POSITION ]; then
-        options="shell cpid add del update print import export"
+        options="shell scp cpid add del update print import export"
     fi
     COMPREPLY=( $(compgen -W "${options}" -- ${cur}) )
     return 0

data/features/scp.feature

@@ -0,0 +1,59 @@
+Feature: Scp to copy files and directories to and from a remote host
+  In order to copy files and directories to/from a bookmarks
+  I want to be able to invoke the scp command on these bookmarks.
+
+  Background:
+    Given Bookmark "some host1" exist with:
+      | name      | value     |
+      | host-name | some.host |
+    Given Bookmark "some host2" exist with:
+      | name      | value      |
+      | host-name | some.host2 |
+      | login     | mylogin    |
+    Given Bookmark "some host3" exist with:
+      | name      | value             |
+      | host-name | some.host3        |
+      | login     | otherlogin        |
+      | option    | ForwardAgent=true |
+
+  Scenario: Copy files to server
+    When I run the "scp" command with "some host1 -- myfile :remotefile"
+    Then It should execute "scp myfile some.host:remotefile"
+
+  Scenario: Copy files from server
+    When I run the "scp" command with "some host1 -- :remotefile myfile"
+    Then It should execute "scp some.host:remotefile myfile"
+
+  Scenario: Copying directories
+    When I run the "scp" command with "-r some host1 -- myfile :remotefile"
+    Then It should execute "scp -r myfile some.host:remotefile"
+
+  Scenario: Bookmark with login
+    When I run the "scp" command with "some host2 -- :remotefile myfile"
+    Then It should execute "scp mylogin@some.host2:remotefile myfile"
+
+  Scenario: Bookmark with ssh options
+    When I run the "scp" command with "some host3 -- myfile :remotefile"
+    Then It should execute "scp -o ForwardAgent=true myfile otherlogin@some.host3:remotefile"
+
+  Scenario: Scp with bandwidth limit
+    When I run the "scp" command with "-l 100 some host1 -- :remotefile myfile"
+    Then It should execute "scp -l 100 some.host:remotefile myfile"
+
+  Scenario: scp with full path
+    When I run the "scp" command with "some host1 -- :/path/to/remote /path/to/local"
+    Then It should execute "scp some.host:/path/to/remote /path/to/local"
+
+  Scenario: scp without indicating remote file
+    When I run the "scp" command with "some host1 -- somefile otherfile"
+    Then I should get a "The remote path should be prefixed with" error
+
+  Scenario: scp with wrong number of arguments
+    When I run the "scp" command with "some host1 -- one two three"
+    Then I should get a "Invalid targets: one two three" error
+
+  Scenario: Overriding hostname or login
+    When I run the "scp" command with "-n newhost some host2 -- :remote local"
+    Then It should execute "scp mylogin@newhost:remote local"
+    When I run the "scp" command with "-L otherlogin some host2 -- local :remote"
+    Then It should execute "scp local otherlogin@some.host2:remote"

data/lib/runsshlib/cli.rb

@@ -20,7 +20,7 @@ require 'trollop'
 module RunSSHLib
   class CLI
 
-    COMMAND = %w(shell add del update print import export cpid)
+    COMMAND = %w(shell add del update print import export cpid scp)
     MAIN_HELP = <<-EOS
 Usage: runssh [global_options] COMMAND [options] <path>
 
@@ -36,6 +36,7 @@ COMMAND : One of the commands mentioned below. It's possible to
 
 Available commands:
 * shell  : Open ssh shell on remote host
+* scp    : Copy files from/to remote host
 * add    : Add host definition
 * del    : Delete host definition
 * update : Update host definition
@@ -86,7 +87,7 @@ EOS
         m = method(command_name.to_sym)
         m.call(@path)
       end
-    rescue ConfigError => e
+    rescue ConfigError, ParametersError => e
       Trollop.die e.message
     rescue AbortError => e
       abort e.message
@@ -130,6 +131,8 @@ EOS
       case cmd
       when 'shell'
         parse_shell args
+      when 'scp'
+        parse_scp args
       when 'add', 'update'
         parse_add_update cmd, args
       when 'del'
@@ -203,6 +206,54 @@ EOS
       options
     end
 
+    def parse_scp(args)
+      options = Trollop::options(args) do
+        banner <<-EOH
+Usage: runssh [global_options] scp [options] <path> -- [:]target [:]target
+
+<path> : See main help for description of path.
+
+Copy file/directory to/from remote host using scp. The remote target should
+be prefixed with ':'. The paths can be relative or absolute. The remote 
+target is extracted to [user@]host:target.
+
+Here are some examples to make it clear. Say you have a bookmark named
+"some host" which points to 'some.host' and uses 'root' as login:
+
+The command:
+  runssh scp some host -- localfile :remotefile
+Is equivalent to:
+  scp localfile root@some.host:remotefile
+
+The command:
+  runssh scp -r some host -- :/path/to/remotedirectory /path/to/localdirectory
+Is equivalent to:
+  scp -r root@some.host:/path/to/remotedirectory /path/to/localdirectory
+
+Options:
+EOH
+        opt :login, "Override the login in the configuration.",
+            :type => :string, :short => :L
+        opt :host_name, 'Override the name or address of the host.',
+            :short => :n, :type => :string
+        opt :limit, "Limit the bandwidth. Kbits/s. (Corresponds to scp -l).",
+            :short => :l, :type => :string
+        opt :recurssive, "Recurssively copy entire directory (corresponds to scp -r)",
+            :short => :r
+        opt :option, 'Ssh option. Appended to saved ssh options. ' \
+            'Can be used multiple times.',
+            :short => :o, :type => :string, :multi => true
+        stop_on "--"
+      end
+      # TODO: Can I find a way to specify targets without -- ?
+      if ind = args.index("--")
+        targets = args.slice!(ind, args.size - ind)
+        targets.delete_at(0)
+        options[:targets] = targets
+      end
+      options
+    end
+
     def parse_cpid(args)
       Trollop::options(args) do
         banner <<-EOH
@@ -362,6 +413,19 @@ EOS
       SshBackend.shell(definition)
     end
 
+    def run_scp(path)
+      host = @c.get_host(path)
+      definition = host.definition.merge(@options) do |key, this, other|
+        case key
+        when :option
+          this + other
+        else
+          other ? other : this
+        end
+      end
+      SshBackend.scp(definition)
+    end
+
     def run_cpid(path)
       host = @c.get_host(path)
       SshBackend.copy_id(host.definition.merge(@options))

data/lib/runsshlib/ssh_backend.rb

@@ -59,6 +59,25 @@ module RunSSHLib
       exec command
     end
 
+    # Copy files to/from remote host using scp.
+    # definition: A hash containig a merge between host definition and
+    #             user input.
+    def scp(definition)
+      raise "no hostname" unless definition[:host_name] # should never happen
+      command = "scp"
+      arguments = []
+      arguments << '-r' if definition[:recurssive_given]
+      arguments += ['-l', definition[:limit]] if definition[:limit]
+      definition[:option].each do |option|
+        arguments += ['-o', option]
+      end if definition[:option]
+      host_name = definition[:login] ?
+                  "#{definition[:login]}@#{definition[:host_name]}" :
+                  definition[:host_name]
+      arguments += normalize_scp_targets(definition[:targets], host_name)
+      exec command, *arguments
+    end
+
     # Copy ssh identity file to remote host according to options
     # options:: A hash containing host definition (:host_name, etc) and
     #           optionally identity_file path.
@@ -78,5 +97,24 @@ module RunSSHLib
       tunnel_definition =~ /(^\d+$)/ ? "#{$1}:localhost:#{$1}" :
                            tunnel_definition
     end
+
+    # Prepend the remote target with supplied host_name.
+    #
+    # Raises ParametersError if no target is indicated as remote
+    # (with ':') or if the number of targets is not 2.
+    def normalize_scp_targets(targets, host_name)
+      raise ParametersError, "Invalid targets: #{targets.join(' ')}" unless
+            targets.length == 2
+      raise "no hostname" unless host_name # should never happen
+
+      if targets[0].start_with?(':')
+        targets[0] = host_name + targets[0]
+      elsif targets[1].start_with?(':')
+        targets[1] = host_name + targets[1]
+      else
+        raise ParametersError, "The remote path should be prefixed with ':'!"
+      end
+      targets
+    end
   end
 end

data/lib/runsshlib/version.rb

@@ -19,10 +19,9 @@
 module RunSSHLib
   module Version
     MAJOR = 0
-    MINOR = 4
-    BUILD = 3
+    MINOR = 5
+    BUILD = 0
 
     STRING = [MAJOR, MINOR, BUILD].compact.join('.')
   end
 end
-

data/lib/runsshlib.rb

@@ -38,6 +38,9 @@ module RunSSHLib
   # message should contain only the older config version!
   class OlderConfigVersionError < StandardError; end
 
+  # Parameters error
+  class ParametersError < StandardError; end
+
   # Just a general abort with error
   class AbortError < StandardError; end
 

data/spec/runsshlib/cli_spec.rb

@@ -283,8 +283,12 @@ describe "The CLI interface" do
       @ab_cli.send(:extract_subcommand, ['a']).should eql('add')
     end
 
-    it "should parse 's' as shell" do
-      @ab_cli.send(:extract_subcommand, %w(s root)).should eql('shell')
+    it "should parse 'sh' as shell" do
+      @ab_cli.send(:extract_subcommand, %w(sh root)).should eql('shell')
+    end
+
+    it "should parse 'sc' as scp" do
+      @ab_cli.send(:extract_subcommand, %w(sc root)).should eql('scp')
     end
 
     it "should parse 'i' as import" do

data/spec/runsshlib/ssh_backend_spec.rb

@@ -131,4 +131,34 @@ describe RunSSHLib::SshBackend do
           should == "7070:localhost:7070"
     end
   end
+
+  describe "#normalize_scp_targets" do
+    it "raises exception if not hostname given" do
+      expect {
+        RunSSHLib::SshBackend.normalize_scp_targets([1, 2], nil)
+      }.to raise_error(RuntimeError, /no hostname/)
+    end
+
+    it "raises error if number of targets doesn't match 2" do
+      expect {
+        RunSSHLib::SshBackend.normalize_scp_targets([1], 'some.host')
+      }.to raise_error(RunSSHLib::ParametersError, /Invalid targets/)
+      expect {
+        RunSSHLib::SshBackend.normalize_scp_targets([1, 2, 3], 'some.host')
+      }.to raise_error(RunSSHLib::ParametersError, /Invalid targets/)
+    end
+
+    it "raises an error if none of the targets prefixed with :" do
+      expect {
+        RunSSHLib::SshBackend.normalize_scp_targets(['one', 'two'], 'host')
+      }.to raise_error(RunSSHLib::ParametersError, /should be prefixed/)
+    end
+
+    it "correctly parses targets" do
+      RunSSHLib::SshBackend.normalize_scp_targets([':remotefile', 'localfile'],
+                 'host').should == ['host:remotefile', 'localfile']
+      RunSSHLib::SshBackend.normalize_scp_targets(['/path/to/localfile', ':/path/to/remotefile'],
+                 'host').should == ['/path/to/localfile', 'host:/path/to/remotefile']
+    end
+  end
 end

data/spec/support/utils.rb

@@ -122,7 +122,7 @@ end
 def stub_ssh_exec
   RunSSHLib::SshBackend.stub(:exec) do |_command, *args|
     output = _command
-    output + args.join(" ") unless args.empty?
+    output += (' ' + args.join(" ")) unless args.empty?
     puts output
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: runssh
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 3
-  version: 0.4.3
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Haim Ashkenazi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-19 00:00:00 +03:00
+date: 2011-05-22 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,6 +81,7 @@ files:
 - features/import_bookmarks.feature
 - features/print_bookmarks.feature
 - features/run_shell.feature
+- features/scp.feature
 - features/step_definitions/argument_steps.rb
 - features/step_definitions/bookmarks_steps.rb
 - features/step_definitions/output_steps.rb
@@ -150,6 +151,7 @@ test_files:
 - features/import_bookmarks.feature
 - features/print_bookmarks.feature
 - features/run_shell.feature
+- features/scp.feature
 - features/step_definitions/argument_steps.rb
 - features/step_definitions/bookmarks_steps.rb
 - features/step_definitions/output_steps.rb