cronbox 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 344b223d39b260d6f3197c8dc6d98686d7171955
+  data.tar.gz: 4980b00c568b679f1e4efe53e5aecbafcd294179
+SHA512:
+  metadata.gz: 3b676ba4b02121ed2e8cb43579ccf851c1f5f20fb14506aa9ce066c9393d1a1aafd10fa5a978b7ea8a610971585ce3b98f607773b70a9dad409500dda6cf655b
+  data.tar.gz: 7b5c9b99eaf732da774d166f914c1d864d21487f2af44c0c4286205e413a9df91025c8770773a92399797751e1caa7629a5fcf7c9589e41ebf9cb03b17e30b1b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/version.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+  - 1.9.2
+
+notifications:
+  email: false

data/.versioneer.yml

@@ -0,0 +1,8 @@
+# Versioneer Project Configuration
+# https://git.io/versioneer-help
+
+type: Git
+bump_segment: minor
+prereleases:
+  - alpha
+  - beta

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 BinaryBabel OSS
+
+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,71 @@
+# Cronbox
+
+**Command line inbox and timecard for scheduled job status and output.**
+
+Run any scheduled command through Cronbox to store its exit status and output for later review and diagnostics. Data is stored as simple JSON in the default location of `$HOME/.cronbox`
+
+```
+| Cronbox |                                                  *=Output
+=====================================================================
+| ID | COMMAND                              | EXIT |           WHEN |
+=====================================================================
+|  1 | /usr/local/bin/task sync             |    0 | 12 minutes ago |
+---------------------------------------------------------------------
+|  2 | ~/Dropbox/bin/run-daily-backup       |   *0 | 20 minutes ago |
+---------------------------------------------------------------------
+```
+
+## Installation
+
+    $ gem install cronbox
+
+## Usage
+
+For complete usage options, please consult `cb --help`
+
+    $ cb                  # Query cronbox index timecard
+    $ cb CMD [ARGS]       # Run and record output of command
+    $ cb -o ID            # Review full-output of entry
+    
+### CRONTAB USAGE WITH RVM
+
+If you're using RVM to manage Ruby, Cronbox may not be available to crontab due to missing paths. Try adding the following two options to the top of your file:
+
+```
+SHELL=/bin/bash
+BASH_ENV=$HOME/.profile
+* * * * * cb true          # Cronbox testing
+```
+
+* Depending on your OS/Environment you might require `.bash_profile` instead. 
+* The `cb true` test line should show up on your Cronbox timecard.
+  * Once it does you'll know you have everything working correctly and can remove it.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/binarybabel/cronbox.
+
+* After checking out the repo, run `bin/setup` to install dependencies.
+* Then, run `rake test` to run the tests.
+
+
+## Author & License
+
+                                                                                 0101010            
+                                                                              0010011               
+                                                                            110101                  
+                                                                          0011                      
+             __   __   __        __   __                                           0100010          
+            /  ` |__) /  \ |\ | |__) /  \ \_/                         1010    0010101000001         
+            \__, |  \ \__/ | \| |__) \__/ / \                       010101110100111101010010        
+                                                                   01     0011000100                
+                A BinaryBabel OSS Project                                                           
+                                                                     0100                           
+                                                                  01001001    binarybabel.org       
+                                                                 0100111001    000001010001110      
+                                                                101       0010010000010100100101    
+                                                            00111          0010011110100011001010   
+                                                            0110            10000010100111001000100 
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test
+
+task :versioneer do
+  system './bin/versioneer relock'
+end
+
+Rake::Task[:build].enhance [:versioneer] do
+  system './bin/versioneer unlock -q'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cronbox"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/versioneer

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'versioneer' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("versioneer", "versioneer")

data/cronbox.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cronbox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cronbox'
+  spec.version       = Cronbox::VERSION
+  spec.authors       = ['BinaryBabel OSS']
+  spec.email         = ['oss@binarybabel.org']
+
+  spec.summary       = 'Command line inbox and timecard for scheduled job status and output.'
+  spec.homepage      = 'https://github.com/binarybabel/cronbox'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.files += ['version.lock']
+  spec.add_runtime_dependency 'versioneer'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0.10.0'
+  spec.add_development_dependency 'pry-byebug', '> 3'
+end

data/exe/cb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'optparse'
+require 'cronbox'
+
+options = {}
+
+opparser = OptionParser.new do |opts|
+  opts.banner = [
+      '',
+      'Cronbox Usage          https://git.io/cronbox',
+      '---------------------------------------------',
+      '  Query: cb [-e]',
+      '    Run: cb [-l LABEL] RUN_CMD [CMD_ARGS]',
+      '---------------------------------------------',
+      '',
+      ' Options:'
+  ].join("\n")
+  opts.on('-f DATA_FILE', '--file DATA_FILE', 'Data file, default: $HOME/.cronbox') do |v|
+    options[:file] = v
+  end
+  opts.on('-e', '--errors', 'Report errors only, with log output') do
+    options[:report] = 'errors'
+  end
+  opts.on('-l LABEL', '--label NAME', 'Store run-command with label') do |v|
+    options[:label] = v
+  end
+  opts.on('-o ID_OR_NAME', '--output ID_OR_NAME', 'Report command full output') do |v|
+    options[:output] = v
+  end
+  opts.on('-d ID_OR_NAME', '--delete ID_OR_NAME', 'Remove cronbox entry') do |v|
+    options[:delete] = v
+  end
+end
+opparser.parse!
+
+file = options[:file]
+options.delete(:file)
+
+@app = Cronbox.new(file)
+@cli = Cronbox::CliWrapper.new(@app)
+
+if ARGV.empty? and (options.empty? or options[:report])
+  @cli.report(options[:report])
+elsif ARGV.size > 0
+  @app.execute(options[:label], ARGV.shift, *ARGV)
+elsif options[:output]
+  @cli.report(true, [options[:output]])
+elsif options[:delete]
+  @cli.delete(options[:delete])
+else
+  puts opparser.help
+end

data/lib/cronbox.rb

@@ -0,0 +1,96 @@
+require 'open3'
+require 'cronbox/version'
+require 'cronbox/data_file'
+require 'cronbox/cli_wrapper'
+
+class Cronbox
+
+  def initialize(file=nil)
+    file ||= File.join(Dir.home, '.cronbox')
+    @data = Cronbox::DataFile.new(file)
+  end
+
+  attr_reader :data
+
+  def report(errors_only=false)
+    entries = @data.entries.sort_by { |e| e['ts'] }
+    report = {
+        count: 0,
+        errors: 0,
+        entries: [],
+    }
+    entries.reverse.each do |e|
+      e = e.clone
+      e['is_error'] = e['status'].to_i > 0
+      e['when'] = self.class.time_delta_string(e['ts'])
+      e['has_output'] = (e['output'].respond_to?(:size) && e['output'].size > 0)
+      next if errors_only and not e['is_error']
+      report[:count] += 1
+      report[:errors] += 1 if e['is_error']
+      report[:entries].push e
+    end
+    report
+  end
+
+  def execute(label, cmd, *args)
+    e = Hash.new
+    e['command'] = ([cmd] + args).join(' ')
+    e['status'] = nil
+    e['output'] = []
+    e['label'] = label.to_s unless label.to_s.empty?
+    begin
+      e['ts'] = Time.now.to_i
+      Open3.popen3(cmd, *args) do |stdin, stdout, stderr, thread|
+        e['status'] = thread.value.to_i
+        e['output'] = stderr.readlines + stdout.readlines
+      end
+    rescue => ex
+      e['status'] = 1
+      e['output'] = [ex.message]
+    end
+
+    existing = @data.find_entry(label: e['label']) if e['label']
+    existing ||= @data.find_entry(command: e['command'])
+
+    if existing
+      e['label'] ||= existing['label']
+      existing.merge!(e)
+    else
+      @data.add_entry(e)
+    end
+
+    @data.save!
+  end
+
+  def delete(id_or_label)
+    if id_or_label.to_i > 0
+      e = @data.find_entry(id: id_or_label.to_i)
+    else
+      e = @data.find_entry(label: id_or_label)
+    end
+    if e
+      @data.del_entry(e)
+      @data.save!
+      e
+    else
+      nil
+    end
+  end
+
+  def self.time_delta_string(time)
+    d = Time.now.to_i - time.to_i
+    case d
+      when 0 then 'just now'
+      when 1 then 'a second ago'
+      when 2..59 then d.to_s+' seconds ago'
+      when 60..119 then 'a minute ago' #120 = 2 minutes
+      when 120..3540 then (d/60).to_i.to_s+' minutes ago'
+      when 3541..7100 then 'an hour ago' # 3600 = 1 hour
+      when 7101..82800 then ((d+99)/3600).to_i.to_s+' hours ago'
+      when 82801..172000 then 'a day ago' # 86400 = 1 day
+      when 172001..518400 then ((d+800)/(60*60*24)).to_i.to_s+' days ago'
+      when 518400..1036800 then 'a week ago'
+      else ((d+180000)/(60*60*24*7)).to_i.to_s+' weeks ago'
+    end
+  end
+end

data/lib/cronbox/cli_wrapper.rb

@@ -0,0 +1,112 @@
+class Cronbox
+  class CliWrapper
+    def initialize(app)
+      @app = app
+    end
+
+    def report(type=nil, include_only=nil)
+      if include_only
+        include_ids = include_only.map(&:to_i)
+        include_labels = include_only.map(&:to_s)
+      end
+
+      any_output = false
+
+      report = @app.report(type.eql? 'errors')
+      report[:entries].each do |e|
+        if e['label'].to_s.empty?
+          e['f_label'] = e['id'].to_s
+        else
+          e['f_label'] = %("#{e['label']}" #{e['id']})
+        end
+        if e['has_output']
+          any_output = true
+          e['f_status'] = '*' + e['status'].to_s
+        else
+          e['f_status'] = e['status'].to_s
+        end
+      end
+
+      fw = self.class.calc_widths_of_fields(report[:entries], {
+          f_label: [2], command: [10, 70], f_status: [4], when: [4]
+      })
+      w = fw.values.reduce(:+) + fw.size*3 + 1
+
+      ## BRAND
+      puts ''
+      brand = '| Cronbox |'
+      if any_output
+        puts "%s%#{w-brand.length}s" % [brand, '*=Output']
+      else
+        puts brand
+      end
+      puts '=' * w
+
+      ## HEADER ROW
+      tpl = [nil,
+             "%#{fw[:f_label]}s",
+             "%-#{fw[:command]}s",
+             "%#{fw[:f_status]}s",
+             "%#{fw[:when]}s",
+             nil].join(' | ').strip
+      puts tpl % %w(ID COMMAND EXIT WHEN)
+      puts '=' * w
+
+      ## ENTRY ROWS
+      report[:entries].each do |e|
+        if include_only
+          next unless include_ids.include? e['id'] or include_labels.include? e['label']
+        end
+        puts tpl % [
+            e['f_label'],
+            e['command'],
+            e['f_status'],
+            e['when']
+        ]
+        if type == 'errors' or type === true
+          if e['has_output']
+            puts 'v' * w
+            puts ''
+            puts e['output'].join("\n").sub(/\s*\z/, '')
+            puts ''
+          end
+          puts '-' * w
+        else
+          puts '-' * w
+        end
+      end
+      puts ''
+    end
+
+    def delete(entry)
+      if (entry = @app.delete(entry))
+        STDERR.write("Deleted entry ##{entry['id']}\n")
+      end
+    end
+
+    def self.calc_widths_of_fields(table, fields_with_opts)
+      result = Hash.new
+      fields = fields_with_opts.keys
+      table.each do |e|
+        fields.each do |f|
+          w = e[f.to_s].to_s.length
+          result[f] = [result[f].to_i, w].max
+        end
+      end
+      fields_with_opts.each do |f, opts|
+        opts = [0, 99] unless opts
+        opts.push(99) unless opts.length > 1
+        result[f] = [[result[f].to_i, opts[0]].max, opts[1]].min
+      end
+      result
+    end
+
+    def self.calc_width_of_field(table, field, min=0, max=99)
+      field = field.to_s
+      width = table.inject(0) do |w, e|
+        [w, e[field].to_s.length].max
+      end
+      [[width, min].max, max].min
+    end
+  end
+end

data/lib/cronbox/data_file.rb

@@ -0,0 +1,84 @@
+require 'json'
+
+class Cronbox
+  class DataFile
+    def initialize(file)
+      @file = file
+      reset
+      reload if File.exist?(@file)
+    end
+
+    def reset
+      @config ||= Hash.new
+      @entries = Array.new
+    end
+
+    def reload
+      import_text(File.read(@file))
+    end
+
+    def save!
+      save_dir = File.dirname(@file)
+      unless Dir.exist?(save_dir)
+        raise "Directory does not exist, #{save_dir}"
+      end
+      File.open(@file, 'w') { |file| file.write(export_text) }
+    end
+
+    def empty!
+      reset
+      save!
+    end
+
+    attr_accessor :config, :entries
+
+    def find_entry(query)
+      k = query.keys.first
+      v = query[k]
+      return nil unless v
+      @entries.each do |e|
+        if e[k.to_s] == v
+          return e
+        end
+      end
+      nil
+    end
+
+    def add_entry(entry)
+      entry['id'] = next_id
+      @entries.push entry
+    end
+
+    def del_entry(entry)
+      @entries.delete(entry)
+    end
+
+    protected
+
+    def import_text(input)
+      data = JSON.parse(input)
+      @config = data['config'] || Hash.new
+      @entries = data['entries'] || Array.new
+    end
+
+    def export_text
+      JSON.pretty_generate({
+          :'config' => @config,
+          :'entries' => @entries.sort_by { |e| e['id'] }
+      })
+    end
+
+    def next_id
+      ni = 1
+      indexes = @entries.map { |e| e['id'].to_i }
+      indexes.sort.each do |i|
+        if i > ni
+          return ni
+        elsif i == ni
+          ni += 1
+        end
+      end
+      ni
+    end
+  end
+end

data/lib/cronbox/version.rb

@@ -0,0 +1,5 @@
+require 'versioneer'
+
+class Cronbox
+  VERSION = ::Versioneer::Config.new(::File.expand_path('../../../', __FILE__))
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: cronbox
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- BinaryBabel OSS
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: versioneer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 
+email:
+- oss@binarybabel.org
+executables:
+- cb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".versioneer.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/versioneer
+- cronbox.gemspec
+- exe/cb
+- lib/cronbox.rb
+- lib/cronbox/cli_wrapper.rb
+- lib/cronbox/data_file.rb
+- lib/cronbox/version.rb
+- version.lock
+homepage: https://github.com/binarybabel/cronbox
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Command line inbox and timecard for scheduled job status and output.
+test_files: []