open4ssh 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78635fba401d382c7a6cf79897cb94e89ec54175
-  data.tar.gz: 3a33cebef1a16d8071d4dc2c7aefa849a6f60888
+  metadata.gz: 64411bd7946581982389a29fa49974703aaac6a4
+  data.tar.gz: 7dae3d9662aa2373ffd4246a3a2f4b76b7e3531b
 SHA512:
-  metadata.gz: 0f380979bfca37db680e5bf1e0f7ba1c4966279ee5e879caafbc73216d261a48ebab5905f8641ca1c8c9acf09029d5a42420a35f55b90ff975551482f18aa5ed
-  data.tar.gz: 0e11987f6bcdb82f4dd1c3586dade177189dfc8a6495fa89913afb8f72868ed62676c75d0f7129afb577b4b14c85b4238042da2e5d698b19d987c6e60e9f90cb
+  metadata.gz: 412afd60971d813b4febfbcea213f10965f25163a7ed3486c6b1b85b219d9701c3cfc7c5af91934caadd12fd7432ebe24afabc7535326732c235846ee96f9bef
+  data.tar.gz: d50cd2d1c3f7bf6bbfa42b6941aa6ad2f7471b3785bbc0a93c057aae5d3550477d70b4b6225f47502072030a01cfa88b433471fd2089a2351e88598a53c4978c

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## Version 0.1.1
+
+Warning, this update is not backward compatible.
+
+- renamed exec to capture function (better alignment to Open3)
+- renamed exec3 to capture3 function (better alignment to Open3)
+
+## Version 0.1.0
+
+Initial release.
+
+- exec function
+- exec3 function

data/README.md

@@ -35,7 +35,7 @@ Or install it yourself as:
 
 ### Remote execution of a single command via SSH
 
-All parameters of the _exec_ command are explained [here](Open4ssh.html#exec-class_method).
+All parameters of the _capture_ command are explained [here](Open4ssh.html#capture-class_method).
 
 However, the following snippets explain how to use Open4ssh. 
 To execute simply one single command on a remote host, we can do the following:
@@ -43,7 +43,7 @@ To execute simply one single command on a remote host, we can do the following:
 ```ruby
 require 'open4ssh'
 
-stdout = Open4ssh.exec(
+stdout = Open4ssh.capture(
      host: 'remote.host.io',
      user: 'nane',
      pwd: 'secret',
@@ -60,7 +60,7 @@ For a lot of cloud scenarios it is more appropriate to support a keybased login.
 ```ruby
 require 'open4ssh'
 
-stdout = Open4ssh.exec(
+stdout = Open4ssh.capture(
      host: 'remote.host.io',
      user: 'nane',
      key: '/path/to/your/sshkey.pem',
@@ -71,7 +71,7 @@ puts stdout
 
 ### Remote execution of a sequence of commands via SSH
 
-All parameters of the _exec4_ command are explained [here](Open4ssh.html#exec4-class_method).
+All parameters of the _capture4_ command are explained [here](Open4ssh.html#capture4-class_method).
 The following snippets will explain how to use Open4ssh to execute a (sequence) of commands.
 
 This snippet here will execute five shell commands sequentially
@@ -80,7 +80,7 @@ This snippet here will execute five shell commands sequentially
 require 'open4ssh'
 require 'pp'
 
-returns = Open4ssh.exec4(
+returns = Open4ssh.capture4(
      host: 'remote.host.io',
      user: 'nane',
      key: '/path/to/your/sshkey.pem',
@@ -117,7 +117,7 @@ each command could be successfully processed (exit code 0). So this snippet here
 require 'open4ssh'
 require 'pp'
 
-returns = Open4ssh.exec4(
+returns = Open4ssh.capture4(
      host: 'remote.host.io',
      user: 'nane',
      key: '/path/to/your/sshkey.pem',
@@ -146,7 +146,7 @@ Because Open4ssh only executes commands as long as they are returning a exit cod
 pragmatically whether all commands of a sequence have been executed successfully:
 
 ```ruby
-exit_code, stderr, stdout, command = Open4ssh.exec4(
+exit_code, stderr, stdout, command = Open4ssh.capture4(
      host: 'remote.host.io',
      user: 'nane',
      key: '/path/to/your/sshkey.pem',
@@ -169,7 +169,7 @@ end
 Just a small example. Assuming your remote host is a Ubuntu 14.04 system we could do something like that:
 
 ```ruby
-exit_code, stdout, stderr, command = Open4ssh.exec4(
+exit_code, stdout, stderr, command = Open4ssh.capture4(
      host: 'remote.host.io',
      user: 'nane',
      key: '/path/to/your/sshkey.pem',
@@ -193,7 +193,7 @@ Of course, you can do any other tasks as well. This was only one example ;-)
 If you want to know what is happening there you can turn on the verbose mode (mostly useful for debugging).
 
 ```ruby
-exit_code, stdout, stderr, command = Open4ssh.exec4(
+exit_code, stdout, stderr, command = Open4ssh.capture4(
      host: 'remote.host.io',
      user: 'nane',
      key: '/path/to/your/sshkey.pem',

data/Rakefile

@@ -2,7 +2,7 @@ require "bundler/gem_tasks"
 require 'yard'
 
 YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb', '-', 'README.md', 'LICENSE.txt']
+  t.files   = ['lib/**/*.rb', '-', 'README.md', 'LICENSE.txt', 'CHANGELOG.md']
   # t.options = ['--any', '--extra', '--opts']
   t.stats_options = ['--list-undoc']
 end

data/lib/open4ssh/version.rb

@@ -1,3 +1,3 @@
 module Open4ssh
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/open4ssh.rb

@@ -3,7 +3,7 @@ require "net/ssh"
 
 module Open4ssh
 
-  # Executes a shell command on a remote host via SSH and returns the console output.
+  # Executes a shell command on a remote host via SSH and captures the console output.
   #
   # @param host [String] DNS name or IP address of the remote host (required)
   # @param port [Integer] Port (defaults to 22)
@@ -14,7 +14,16 @@ module Open4ssh
   #
   # @return [String] console output of executed command (output includes stdout and stderr)
   #
-  def self.exec(host: '', user: '', port: 22, key: '', pwd: '', cmd: '')
+  # @example
+  #   stdout = Open4ssh.capture(
+  #       host: 'remote.host.io',
+  #       user: 'nane',
+  #       pwd: 'secret',
+  #       cmd: 'ls -la'
+  #   )
+  #   puts stdout
+  #
+  def self.capture(host: '', user: '', port: 22, key: '', pwd: '', cmd: '')
     stdout = ""
     keys = [key]
 
@@ -26,7 +35,7 @@ module Open4ssh
     return stdout
   end
 
-  # Executes a list of shell commands on a remote host via SSH and returns their exit codes, stdouts and stderrs.
+  # Executes a list of shell commands on a remote host via SSH and captures their exit codes, stdouts and stderrs.
   # The commands are executed sequentially until a command terminates with an exit code not equal 0 (no success).
   #
   # @param host [String] DNS name or IP address of the remote host (required)
@@ -39,7 +48,20 @@ module Open4ssh
   #
   # @return [Array<exit_code, stdout, stderr, command>] List of exit_code, stdout, stderr and executed commands
   #
-  def self.exec4(host: '', user: '', port: 22, key: '', pwd: '', cmd: [], verbose: false)
+  # @example
+  #   exit_code, stderr, stdout, command = Open4ssh.capture4(
+  #     host: 'remote.host.io',
+  #     user: 'nane',
+  #     key: '/path/to/your/sshkey.pem',
+  #     cmd: [
+  #     "touch helloworld.txt",
+  #     "cat helloworld.txt",
+  #     "echo 'Hello World' >> helloworld.txt",
+  #     "cat helloworld.txt",
+  #     "rm helloworld.txt"
+  #   ]).last
+  #
+  def self.capture4(host: '', user: '', port: 22, key: '', pwd: '', cmd: [], verbose: false)
     keys    = [key]
     results = []
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open4ssh
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nane Kratzke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -104,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Wrapper around net-ssh for plain execution of remote shell commands.