carrousel 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDllYjNiM2Y5MzY0NDI0MzEyZDZhMTZlNGM0MDY3N2EwYTJiZTY5Zg==
+  data.tar.gz: !binary |-
+    YjhlYzMzNDBlNzE0OTg2YmM5NjIxZmY0NTY2NzZhODE2YTM4NDhlMQ==
+SHA512:
+  metadata.gz: !binary |-
+    MmRjYWJjNjI1Y2M1NmExNjI0NzIxZGZjZTRkM2QxZjdmMTMzNjM0MDU1MjAx
+    MzYxZjI3MjUyZTlhY2NmYTZhYmRhZDZhODlkZTMzOTM2YjIxYmQwZWNjMjE2
+    ZjY5ZTYxNjI2ODZkZmUxZTI2NzkwODVjMzk3NzUxZGIyZTZiNTM=
+  data.tar.gz: !binary |-
+    YWJiZWI4YjViZmJkZTk4ZTIyNDllOWZlZGQ1ZmYxODFhMDNmMjAwNGRhZjgy
+    N2EwMGY3MDVmY2ZjZTFmZTk1OTQ1Mzk5ODdlYjNlNjJkNGFkOGY5NzIzNDQ5
+    MmRhYWQxMzJhMjU5ODljMDAwNTcxOGQ5NDRlZmZmZWRiYzM1YzY=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in carrousel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Raj Sahae
+
+MIT 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/README.md

@@ -0,0 +1,59 @@
+# Carrousel
+
+The Carrousel gem is a command line utility for running a single command on
+multiple targets. Carrousel tracks which commands have succeeded or failed
+based on the return of the system call, and sends failed jobs to the back of
+the line to be tried again later.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'carrousel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carrousel
+
+## Usage
+
+The most basic use case for Carrousel is to give it a command and a list of
+items as command line arguments:
+
+    $ carrousel -c 'echo' foo bar baz
+
+In addition to passing in arguments on the command line, you can also pass them
+in a file. These will be in addition to anything on the command line:
+
+    $ carrousel -c 'echo' -l things-to-echo.txt foo bar baz
+
+While running, carrousel will track it's progress in a carrousel runner status
+file. This file is stored in the present working directory. If you need to kill
+carrousel for any reason, you can pick up where you left off by passing the
+status file into carrousel. The status file will save your completed items,
+incompleted items, and the command used. The file will always be of the form
+~/PWD/.carrousel\_runner\_status\_XXXXXXX. The following example kills the echo
+carrousel and resumes it using a carrousel runner status file:
+
+    $ carrousel -c 'echo' foo bar baz
+    ... CTRL-C to kill this for some reason ...
+    $ carrousel -s .carrousel\_runner\_status\_130b02b
+
+If you would like there to be some sort of delay between individual jobs, you
+can specify that with a delay argument. The following example inserts a 30
+second delay between each echo command:
+
+    $ carrousel -c 'echo' --delay 30 foo bar baz
+  
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+end
+
+task :default => :test

data/bin/carrousel

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require 'carrousel'
+require 'optparse'
+
+@opts = {}
+OptionParser.new do |op|
+  op.banner = "Usage: #{__FILE__} [options] -c COMMAND arg1 [arg2 ...]"
+
+  op.on('-c', '--command COMMAND', 'Execute the given COMMAND') do |c|
+    @opts[:command] = c
+  end
+
+  op.on('-d', '--delay DELAY', 'Sleep for DELAY seconds between commands') do |d|
+    @opts[:delay] = d.to_i
+  end
+
+  op.on('-l', '--listfile FILE', 'Load list of arguments from FILE') do |l|
+    @opts[:listfile] = File.expand_path(l)
+  end
+
+  op.on('-s', '--statusfile FILE', 'Replay FILE with saved command and args') do |s|
+    @opts[:statusfile] = File.expand_path(s)
+  end
+
+  op.on('-v', '--[no-]verbose', 'Enable verbose output') do |v|
+    @opts[:verbose] = v
+  end
+
+  op.on('--[no-]debug', 'Enable debug output') do |d|
+    @opts[:debug] = d
+    @opts[:verbose] ||= d
+  end
+end.parse!
+
+@opts = {
+  :command => nil,
+  :delay => 0,
+  :listfile => nil,
+  :statusfile => nil,
+  :verbose => false,
+  :debug => false
+}.merge(@opts)
+
+Carrousel::Runner.new(ARGV, @opts).run

data/carrousel.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carrousel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carrousel"
+  spec.version       = Carrousel::VERSION
+  spec.authors       = ["Raj Sahae"]
+  spec.email         = ["rajsahae@gmail.com"]
+  spec.description   = %q{Carrousel is a robust utility designed to take a list
+  of generic items, and given some command, perform that command on each item
+  in that list. Depending on the commands return value, Carrousel will track 
+  which items have been completed successfully, and retry items as necessary.
+  It will save your progress in a status database and you can quit the loop 
+  and come back later to finish unprocessed items.}
+  spec.summary       = %q{Robust list based action tracking utility.}
+  spec.homepage      = "https://github.com/rajsahae/carrousel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/carrousel.rb

@@ -0,0 +1,101 @@
+#!/usr/env ruby
+# enconding: UTF-8
+
+require "carrousel/version"
+require 'digest'
+require 'yaml'
+
+##
+# "Enter the Carrousel. This is the time of renewal."
+#
+# Carrousel is a system command execution and tracker utility.
+module Carrousel
+
+  class Runner
+
+    def initialize(args, opts = {})
+      @args = args
+      @opts = opts
+      @incomplete = []
+      @complete = []
+
+      unless @opts[:listfile].nil?
+        lines = File.readlines(@opts[:listfile]).map(&:strip)
+        @incomplete.concat(lines)
+      end
+      @incomplete.concat(@args)
+
+      @opts[:statusfile] ||= generate_status_filename
+      open_status_file
+
+      p self if @opts[:debug]
+
+      raise ArgumentError.new("Command option is required") if @opts[:command].nil?
+    end # def initialize
+
+    def run
+      # Loop over everything in the list. Run the command. If the command fails
+      # then we move the item to the bottom of the list. If the command
+      # succeeds, we move the item to the completed list. If we are interrupted
+      # in the middle of processing, we ensure that the item is saved in the
+      # normal list, and we ensure that we write out the completed list.
+      until @incomplete.empty?
+        begin
+          command = [@opts[:command], @incomplete.first].join(' ')
+          warn "Executing command: #{command}" if @opts[:verbose]
+          resp = system(command)
+          warn "System response: #{resp}" if @opts[:verbose]
+          if resp
+            @complete << @incomplete.delete(@incomplete.first)
+          else
+            @incomplete.rotate!
+          end
+        ensure
+          save_status_file
+        end
+
+        if @opts[:delay] > 0
+          warn "Sleeping for #{@opts[:delay]} seconds" if @opts[:verbose]
+          sleep @opts[:delay]
+        end
+      end # until @incomplete.empty?
+    end # def run
+
+    private
+    def generate_status_filename
+      key = Digest::SHA256.hexdigest(@incomplete.sort.join).slice(0...7)
+      warn "status file key: #{key}" if @opts[:debug]
+      name = self.class.name.gsub('::', '_').downcase
+      File.expand_path(".#{name}_status_#{key}", Dir.pwd)
+    end # def generate_status_filename
+
+    private
+    def open_status_file
+      if File.exists?(@opts[:statusfile])
+        dbs = YAML.load(File.read(@opts[:statusfile]))
+        warn "opened status file:\n#{dbs}" if @opts[:debug]
+        if dbs
+          @opts[:command] ||= dbs[:command]
+          @complete.concat(dbs[:complete])
+          @incomplete.concat(dbs[:incomplete])
+        end
+      end
+    end # def open_status_file
+
+    private
+    def save_status_file
+      warn "Saving status file: #{@opts[:statusfile]}" if @opts[:verbose]
+      File.open(@opts[:statusfile], 'w') do |f|
+        ydb = {
+          :command => @opts[:command],
+          :complete => @complete,
+          :incomplete => @incomplete
+        }.to_yaml
+        f.puts(ydb)
+        warn "Saved status file:\n#{ydb}" if @opts[:debug]
+      end
+      true
+    end # def save_status_file
+
+  end # class Runner
+end # module Carrousel

data/lib/carrousel/version.rb

@@ -0,0 +1,3 @@
+module Carrousel
+  VERSION = "0.0.4"
+end

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'carrousel'
+
+require 'minitest/autorun'

data/test/test_carrousel.rb

@@ -0,0 +1,11 @@
+require 'minitest_helper'
+
+class TestCarrousel < MiniTest::Unit::TestCase
+  def test_that_it_has_a_version_number
+    refute_nil ::Carrousel::VERSION
+  end
+
+  def test_it_does_something_useful
+    assert true
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: carrousel
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Raj Sahae
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "Carrousel is a robust utility designed to take a list\n  of generic
+  items, and given some command, perform that command on each item\n  in that list.
+  Depending on the commands return value, Carrousel will track \n  which items have
+  been completed successfully, and retry items as necessary.\n  It will save your
+  progress in a status database and you can quit the loop \n  and come back later
+  to finish unprocessed items."
+email:
+- rajsahae@gmail.com
+executables:
+- carrousel
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/carrousel
+- carrousel.gemspec
+- lib/carrousel.rb
+- lib/carrousel/version.rb
+- test/minitest_helper.rb
+- test/test_carrousel.rb
+homepage: https://github.com/rajsahae/carrousel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Robust list based action tracking utility.
+test_files:
+- test/minitest_helper.rb
+- test/test_carrousel.rb