sshkit 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.vagrant
+test/tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode

data/.yardoc/checksums

@@ -0,0 +1,13 @@
+lib/deploy.rb 8f584561b611345114f38176ec53bf00f9d5550f
+lib/deploy/all.rb 9fc0b15f0968612fbd2ffaf0bba9dff6f788e3d1
+lib/deploy/host.rb 777a8deedcdd5b41dceab8773c992bafa5ee9f92
+lib/core_ext/hash.rb b7a0f0d1ab3b83f6b251e2f865ad6fa3766124a0
+lib/deploy/command.rb 1a04acc7d5abd1b288bbea3676c287434849ef05
+lib/core_ext/array.rb 3d495a96a0d1566877bf2ebb70ab9ea10a7d32e1
+lib/deploy/version.rb 30e41688e07f7ee74377aaef147250340df4a3f0
+lib/deploy/configuration.rb 3e9f042e0e9e9860d3950a1406a988586434de16
+lib/deploy/backends/netssh.rb c931441edd28ba7e134b0d3ae2fbf40efb347b81
+lib/deploy/backends/printer.rb db41b51e9624105efd7cb7f1fef426b506ebadaa
+lib/deploy/backends/abstract.rb 74260020d3a6c4913f7a3d9294968e1b2a1304a9
+lib/deploy/connection_manager.rb 28c8ef12a8a5923aeaa497ed02fd22869f57186b
+lib/deploy/dsl.rb a487b4e65ab52955b12a5fe55bda99dec61e16b9

data/.yardopts

@@ -0,0 +1 @@
+--no-private - README.md CHANGELOG.md FAQ.md LICENSE.md EXAMPLES.md

data/EXAMPLES.md

@@ -0,0 +1,167 @@
+# Usage Examples
+
+## Run a command as a different user
+
+    on hosts do |host|
+      as 'www-data' do
+        puts capture(:whoami)
+      end
+    end
+
+## Run a command in a different directory
+
+    on hosts do |host|
+      within '/var/log' do
+        puts capture(:head, '-n5', 'messages')
+      end
+    end
+
+## Run a command with specific environmental variables
+
+    on hosts do |host|
+      with rack_env: :test do
+        puts capture("env | grep RACK_ENV")
+      end
+    end
+
+## Run a command in a different directory as a different user
+
+    on hosts do |host|
+      as 'www-data' do
+        in '/var/log' do
+          puts capture(:whoami)
+          puts capture(:pwd)
+        end
+      end
+    end
+
+This will output:
+
+    www-data
+    /var/log
+
+**Note:** This example is a bit misleading, as the `www-data` user doesn't
+have a shell defined, one cannot switch to that user.
+
+## Stack directory nestings:
+
+    on hosts do
+      in "/var" do
+        puts capture(:pwd)
+        in :log do
+          puts capture(:pwd)
+        end
+      end
+    end
+
+This will output:
+
+    /var/
+    /var/log
+
+The directory paths are joined using `File.join()`, which should correctly
+join parts without forcing the user of the code to care about trailing or
+leading slashes. It may be misleading as the `File.join()` is performed on the
+machine running the code, if that's a Windows box, the paths may be incorrectly
+joined according to the expectations of the machine receiving the commands.
+
+## Do not care about the host block:
+
+    on hosts do
+      # The |host| argument is optional, it will
+      # be nil in the block if not passed
+    end
+
+## Redirect all output to `/dev/null`
+
+    SSHKit.config.output = File.open('/dev/null')
+
+## Implement a dirt-simple formatter class:
+
+    class MyFormatter < SSHKit::Formatter::Abstract
+      def write(obj)
+        case obj.is_a? SSHKit::Command
+          # Do something here, see the SSHKit::Command documentation
+        end
+      end
+    end
+
+    SSHKit.config.output = MyFormatter.new($stdout)
+    SSHKit.config.output = MyFormatter.new(SSHKit.config.output)
+    SSHKit.config.output = MyFormatter.new(File.open('log/deploy.log', 'wb'))
+
+## Set a password for a host.
+
+    host = SSHKit::Host.new('user@example.com')
+    host.password = "hackme"
+
+    on host do |host|
+      puts capture(:echo, "I don't care about security!")
+    end
+
+## Execute and raise an error if something goes wrong:
+
+    on hosts do |host|
+      execute!(:echo, '"Example Message!" 1>&2; false')
+    end
+
+This will raise `SSHKit::CommandUncleanExit.new("Example Message!")` which
+will cause the command to abort.
+
+## Do something different on one host, or another depending on a host property:
+
+    host1 = SSHKit::Host.new 'user@example.com'
+    host2 = SSHKit::Host.new 'user@example.org'
+
+    on hosts do |host|
+      target = "/var/www/sites/"
+      if host.hostname =~ /org/
+        target += "dotorg"
+      else
+        target += "dotcom"
+      end
+      execute! :git, :clone, "git@git.#{host.hostname}", target
+    end
+
+## Connect to a host in the easiest possible way:
+
+    on 'example.com' do |host|
+      execute :uptime
+    end
+
+This will resolve the `example.com` hostname into a `SSHKit::Host` object, and
+try to pull up the correct configuration for it.
+
+
+## Run a command without it being command-mapped:
+
+If the command you attempt to call contains a space character it won't be
+mapped:
+
+    Command.new(:git, :push, :origin, :master).to_s
+    # => /usr/bin/env git push origin master
+    # (also: execute(:git, :push, :origin, :master)
+
+    Command.new("git push origin master").to_s
+    # => git push origin master
+    # (also: execute("git push origin master"))
+
+This can be used to access shell builtins (such as `if` and `test`)
+
+
+## Run a command with a heredoc
+
+An extension of the behaviour above, if you write a command like this:
+
+    c = Command.new <<-EOCOMMAND
+      if test -d /var/log
+      then echo "Directory Exists"
+      fi
+    EOCOMMAND
+    c.to_s
+    # => if test -d /var/log; then echo "Directory Exists; fi
+    # (also: execute <<- EOCOMMAND........))
+
+**Note:** The logic which reformats the script into a oneliner may be naïve, but in all
+known test cases, it works. The key thing is that `if` is not mapped to
+`/usr/bin/env if`, which would break with a syntax error.

data/FAQ.md

@@ -0,0 +1,17 @@
+## Is it better than Capistrano?
+
+*SSHKit* is designed to solve a different problem than Capistrano. *SSHKit* is
+a toolkit for performing structured commands on groups of servers in a
+repeatable way.
+
+It provides concurrency handling, sane error checking and control flow that
+would otherwise be difficult to achive with pure *Net::SSH*.
+
+Since *Capistrano v3.0*, *SSHKit* is used by *Capistrano* to communicate with
+backend servers. Whilst Capistrano provides the structure for repeatable
+deployments.
+
+## Production Ready?
+
+It's in private Beta use, and the documentation could use more work, but this
+is open source, that's more or less how it works.

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    deploy (0.0.1)
+      net-ssh
+      term-ansicolor
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.6.2)
+    ansi (1.4.2)
+    archive-tar-minitar (0.5.2)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    childprocess (0.3.6)
+      ffi (~> 1.0, >= 1.0.6)
+    columnize (0.3.6)
+    debugger (1.2.2)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.5)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.5)
+    erubis (2.7.0)
+    ffi (1.2.0)
+    i18n (0.6.1)
+    json (1.5.4)
+    log4r (1.1.10)
+    metaclass (0.0.1)
+    minitest (2.11.3)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-ssh (2.2.2)
+    rake (10.0.3)
+    redcarpet (2.2.2)
+    term-ansicolor (1.0.7)
+    turn (0.9.3)
+      ansi
+    unindent (1.0)
+    vagrant (1.0.5)
+      archive-tar-minitar (= 0.5.2)
+      childprocess (~> 0.3.1)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6.0)
+      json (~> 1.5.1)
+      log4r (~> 1.1.9)
+      net-scp (~> 1.0.4)
+      net-ssh (~> 2.2.2)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  debugger
+  deploy!
+  minitest (>= 2.11.3, < 2.12.0)
+  mocha
+  rake
+  redcarpet
+  turn
+  unindent
+  vagrant
+  yard