shexecutor 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aad6688b5702d0fe813942cd1749b98d0052550e
-  data.tar.gz: bb27e39942ee31f1676dc14246d62a09a0566efb
+  metadata.gz: 3dbf10b351afc189794bb119a82b063c7c68bb90
+  data.tar.gz: 52b64aa38d6c94ca2bd678a1a6bceb854fd5acbc
 SHA512:
-  metadata.gz: c69fbb39f9224e05fc0458fc838815a27325af30f17fa25dd0e230e6867f3ccdc0ef54e7052a2ac6b482f99fc259e5fffc92afaa8102c437366dd78936e749e0
-  data.tar.gz: 9343f519a5f804a3b1eeac85f91b85138f75440f78f0fa8710a49379d5ddb30fe098ebe097c99af2a1aa62c34e7c3c5f7aa3e39e55b50bd8d498144162f85bdf
+  metadata.gz: 8104a387512908469f7bf9d9887900c848905956e4a03fd75e6a69d30218922b2e67a49b82ff0c4353b5dd89fb4b0d1e36f23d9d9c1a6c3878378aede0caba2a
+  data.tar.gz: 3185e4df180990e334bb2240cca83dc01423de2e40c18ad546c7ff6b4e51dfb4614f80d7511bc7607c5e0b21cdbc6fe3bebafb69363197f3f556ff1317a1227b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shexecutor (0.0.8)
+    shexecutor (0.0.9)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -5,7 +5,7 @@ SHExecutor is a convenience wrapper for executing shell commands from with-in a
 ## It supports:
 - blocking indefinitely, on exit you can get status, stdout and stderr
 - blocking with timeout, on exit you can get status, stdout, stderr, timeout exception (then output streams are not available)
-- non-blocking, then you get no output streams, but status of the forked process
+- non-blocking, then you get handles to the output streams and the status of the forked process
 - replacement, then you get a replaced process and none of the above
 - redirecting of stderr and stdout, separately, to file, with the option to overwrite or append
 
@@ -65,12 +65,12 @@ Or install it yourself as:
 
 ```
 iut = SHExecutor::Executor.new({:wait_for_completion => true, :application_path => "/bin/echo", :params => ["hello world"]})
-iut.execute
+result = iut.execute
 iut.flush
 puts "After execution status is: #{iut.status}"
 # "no longer executing"
 puts "out: #{iut.stdout} err: #{iut.stderr}"
-puts "#{iut.result.pid} success? #{iut.result.success?} with code #{iut.result.exitstatus}"
+puts "#{result.pid} success? #{result.success?} with code #{result.exitstatus}"
 puts "For more see: #{iut.result.methods}"
 ```
 
@@ -78,7 +78,7 @@ puts "For more see: #{iut.result.methods}"
 
 ```
 iut = SHExecutor::Executor.new({:timeout => 1, :wait_for_completion => true, :application_path => "/bin/sleep", :params => ["2"]})
-iut.execute
+result = iut.execute
 # Timeout::Error gets raised. The spawned process continues and needs to be managed separately if required.
 ```
 
@@ -86,8 +86,9 @@ iut.execute
 
 ```
 iut = SHExecutor::Executor.new({:wait_for_completion => false, :application_path => "/bin/sleep", :params => ["1"]})
-iut.execute
+stdout, stderr, thr = iut.execute
 puts "Status: #{iut.status}"
+puts "PID: #{thr.pid}"
 # "run" or "sleep"
 sleep 2
 puts "Status: #{iut.status}"

data/lib/shexecutor/version.rb

@@ -1,3 +1,3 @@
 module SHExecutor
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/lib/shexecutor.rb

@@ -19,14 +19,21 @@ module SHExecutor
   end
 
   class Executor
-    attr_accessor :options
+    public
+
     attr_accessor :stdout
     attr_accessor :stderr
+    attr_accessor :options
+
+    private
+    
     attr_accessor :result
     attr_accessor :pid
     attr_accessor :data_out
     attr_accessor :data_err
 
+    public
+
     def initialize(options = ::SHExecutor::default_options)
       # set default options
       @options = ::SHExecutor::default_options.dup
@@ -50,10 +57,6 @@ module SHExecutor
       @result.value
     end
 
-    def possible_injection?(application_path)
-      (@options[:protect_against_injection]) and (@options[:application_path].include?(" ") or @options[:application_path].tainted?)
-    end
-
     def validate
       errors = []
       if (@options[:protect_against_injection]) and (!@options[:application_path].nil? and @options[:application_path].strip != "")
@@ -104,8 +107,31 @@ module SHExecutor
       stderr_to_file if (@options[:stderr_path])
     end
 
+    def execute_blocking(application_path, params = nil)
+      executor = SHExecutor::Executor.new({:wait_for_completion => true, :application_path => application_path, :params => params})
+      result = executor.execute
+      executor.flush
+      return result, executor.stdout, executor.stderr
+    end
+
+    def execute_and_timeout_after(application_path, params = nil, timeout = -1)
+      executor = SHExecutor::Executor.new({:timeout => timeout, :wait_for_completion => true, :application_path => application_path, :params => params})
+      result = executor.execute
+      executor.flush
+      return result, executor.stdout, executor.stderr
+    end
+
+    def execute_non_blocking(application_path, params = nil)
+      executor = SHExecutor::Executor.new({:wait_for_completion => false, :application_path => application_path, :params => params})
+      executor.execute
+    end
+
     private
 
+    def possible_injection?(application_path)
+      (@options[:protect_against_injection]) and (@options[:application_path].include?(" ") or @options[:application_path].tainted?)
+    end
+
     def buffer_to_file(buffer, path, append)
       if not append
         FileUtils.rm_f(path)
@@ -199,6 +225,7 @@ module SHExecutor
     def fork_process
       validate
       @stdin_stream, @stdout_stream, @stderr_stream, @result = Open3::popen3(@options[:application_path], *@options[:params]) 
+      return @result, @stdout_stream, @stderr_stream
     end
 
     def should_timeout?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shexecutor
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Ernst van Graan