shellshot 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Petyo Ivanov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,56 @@
+= shellshot
+
+by Petyo Ivanov
+http://dekaft.underlog.org
+
+== DESCRIPTION:
+
+A small library dealing with the obscurities of shell commands, piping and timeouts. 
+Most of the stuff comes from bad experience in http://beanstalkapp.com.
+
+== FEATURES/PROBLEMS:
+
+The whole thing would probably not work in Windows. Not my first time I guess.
+
+== SYNOPSIS:
+
+    # Basic usage
+    cmd = Shellshot.exec %q[ruby -e "puts 'Hello World'"]
+
+    # Pipes
+
+    Shellshot.exec "ruby -e %q[ruby -e "puts 'Hello World'"], :stdout => '/tmp/out', :stderr => '/tmp/err'
+    Shellshot.exec "ruby -e %q[ruby -e "puts 'Hello World'"], :stdall => '/tmp/all'
+
+    # Timeout 
+    begin 
+      Shellshot.exec "ruby -e 'sleep 10000'", :timeout => 2 # seconds
+    rescue Timeout::Error => e
+      # ... 
+    end
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME (different license?)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "shellshot"
+    gem.summary = %Q{ruby proxy handling the complexities of system invocations}
+    gem.description = %Q{
+      A small library dealing with the obscurities of shell commands, piping and timeouts. 
+      Most of the stuff comes from bad experience in http://beanstalkapp.com.
+    }
+    gem.email = "underlog@gmail.com"
+    gem.homepage = "http://github.com/underlog/shellshot"
+    gem.authors = ["Petyo Ivanov"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_opts = %w[--format specdoc --color]
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "shellshot #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/shellshot.rb

@@ -0,0 +1,59 @@
+require 'english'
+
+module Shellshot
+  
+  class Command
+
+    alias_method :system_exec, :exec
+
+    DEFAULT_TIMEOUT = 60 #minutes
+
+    attr_accessor :pid, :status
+
+    def exec(command, options = {})
+      self.pid = fork do
+        redefine_stds(options)
+        system_exec(command)
+      end
+
+      begin
+        wait_for(options[:timeout] || DEFAULT_TIMEOUT)
+      rescue Timeout::Error => e
+        terminate_child_process
+        raise
+      end
+    end
+
+    private
+
+    def wait_for(seconds)
+      Timeout.timeout(seconds) do
+        Process.wait(pid)   
+        self.status = $CHILD_STATUS
+      end
+    end
+
+    def terminate_child_process
+      if pid 
+        Process.kill("KILL", pid)
+        Process.wait(pid) # reaping zombie processes. Not sure if correct.
+      end
+    end
+
+    def redefine_stds(options)
+      $stdout.reopen(File.open(options[:stdout], "w+")) if options[:stdout]
+      $stderr.reopen(File.open(options[:stderr], "w+")) if options[:stderr]
+
+      if options[:stdall]
+        combined = File.open(options[:stdall], "w+")
+        $stdout.reopen(combined)
+        $stderr.reopen(combined)
+      end
+    end
+  end
+
+  def self.exec(command, options = {})
+    Shellshot::Command.new().exec(command, options)
+  end
+
+end

data/spec/shellshot_spec.rb

@@ -0,0 +1,32 @@
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Shellshot do
+
+  it "should execute the given command" do
+    Shellshot.exec("touch file")
+    "file".should be_a_file
+  end
+
+  it "should pipe the out to the right file" do 
+    Shellshot.exec(%q[ruby -e 'puts "Hello World"'], :stdout => "file")
+    "file".should contain("Hello World")
+  end
+
+  it "should pipe the err to the right file" do 
+    Shellshot.exec(%q[ruby -e '$stderr << "error"'], :stderr => "file")
+    "file".should contain("error")
+  end
+
+  it "should pipe everything to the right file" do
+    Shellshot.exec(%q[ruby -e '$stderr << "Hello "; puts "World"'], :stdall => "file")
+    "file".should contain("Hello World")
+  end
+
+  it "should cancel execution on time if timeout provided" do
+    lambda { Shellshot.exec %q[ruby -e 'sleep 10000'], :timeout => 1 }.should raise_error(Timeout::Error)
+  end
+
+end
+
+# EOF

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib shellshot]))
+
+require 'tmpdir'
+require 'rubygems'
+require 'ruby-debug'
+
+Spec::Matchers.define :be_a_file do 
+  match do |path|
+    File.exists?(path)
+  end
+end
+
+Spec::Matchers.define :contain do |contents|
+  match do |path|
+    File.exists?(path) && File.read(path).strip == contents
+  end
+
+  failure_message_for_should do |path|
+    if File.exists?(path)
+      "expected #{path} to contain '#{contents}', got '#{File.read(path).strip}'"
+    else
+      "expected #{path} to contain '#{contents}', but the file does not exist."
+    end
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+    @tmpdir = Dir.mktmpdir 
+    Dir.chdir(@tmpdir)
+  end
+
+  config.after(:each) do
+    FileUtils.remove_entry_secure @tmpdir
+  end
+
+end
+
+
+
+# EOF

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: shellshot
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Petyo Ivanov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-12 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "\n      A small library dealing with the obscurities of shell commands, piping and timeouts. \n      Most of the stuff comes from bad experience in http://beanstalkapp.com.\n    "
+email: underlog@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/shellshot.rb
+- spec/shellshot_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/underlog/shellshot
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: ruby proxy handling the complexities of system invocations
+test_files: 
+- spec/shellshot_spec.rb
+- spec/spec_helper.rb