web47command 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b814dd9f0d828dafba8d68fbc7afdd1b201a1d9ecb6dac8b844d93ae07025b3a
+  data.tar.gz: 21c18f8d721ae3a2e65f60d9dd39a67e61e2e64b41de447a77a2eb7e15d3cf35
+SHA512:
+  metadata.gz: 7807c3c193bcb942db4c70da4c0474635813d4c67cba2ebac356a03529f01e963f1d5a4b083e9edbdc25e97107c8765d44072af917c7d9966acbbac8854213c6
+  data.tar.gz: cebde8c5a6d33d0d514ed31fe7682296d1d922ac619f717ee0c69b7c258193887e31a32f298d4a07c5ee0069774b4a0afb49f9c16d87588233adb62d05ace6e8

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 App47
+
+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,75 @@
+# web47command
+Command jobs are types of jobs that use the command line for execution. This library contains a common set of actions that are performed by these types of jobs
+
+## We don't need no sticking badges
+
+*  
+*  
+*  Develop: 
+*  Master: 
+
+## Requirements
+
+*  Ruby 2.4.1
+
+### Working with Bundler and RVM
+
+This project manages Ruby versions via [RVM](http://rvm.beginrescueend.com/) and manages dependencies via [Bundler](http://gembundler.com/). 
+
+You must first [install RVM](http://rvm.beginrescueend.com/rvm/install/).
+Then install Ruby 2.4.1 ([version 2.4.1-p111](http://rvm.beginrescueend.com/interpreters/ruby/)) via RVM. 
+``` shell script
+rvm install 2.4.1
+```
+You'll now notice that this project (as well as other App47 ones) contains a .rvmc file, which is executed upon opening the project's root directory in a terminal (and IDE's like RubyMine). The .rvmc file simply states `rvm ruby-2.4.1` which tells RVM to ensure the Ruby version to use for this project is 2.4.1. 
+
+Please note, your Ruby `2.4.1` version might need bundler installed:
+``` shell script
+gem install bundler -v 1.17.3
+``` 
+
+To set up this project's dependencies, which are defined in the file, `Gemfile`, you should first run
+``` shell script
+bundle install --path vendor
+```
+The `--path vendor` simply puts all gem files in a `vendor` directory. 
+
+## Development
+
+Your `RubyMine` environment should be setup now, however to verify all is well, please run the test suite
+``` shell script
+bundle exec rake test
+```
+
+## Deployment
+The `web47command` project is a gem that will be deployed via [Ruby Gems](https://rubygems.org). When an update is ready, the following steps should be followed
+
+1.   Build the gem `gem build web47command.gemspec`
+2.   Push the new gem to [Ruby Gems](https://rubygems.org) `gem push web47command-version.gem`
+3.   There may be a delay when using the gem file
+
+## Usage
+### Importing the gem
+To use the `app47command` gem in a project, first add the gem to your Gemfile in one of two ways
+
+Using the gem from [Ruby Gems](https://rubygems.org)
+```rbenv-gemsets
+gem 'web47command'
+```
+
+If you need the gem immediately or need to pull from development branch, you can use the git repo
+```rbenv-gemsets
+gem 'web47command', git: 'git@github.com:App47/web47command.git', branch: :master
+```
+or from the develop branch
+```rbenv-gemsets
+gem 'web47command', git: 'git@github.com:App47/web47command.git', branch: :develop
+```
+
+_Please do not ship to production code using the git repo, as the production servers will not have keys to pull from the web47command repo_
+
+### Remove the following files
+1.  `Job` 
+2.  `JobLog` 
+3.  `CommandLogLog` 
+4.  `TrimJobs` 

data/lib/app/jobs/cron/trim_jobs.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Cron
+  #
+  # Clean up Jobs
+  #
+  class TrimJobs < TrimCollection
+    #
+    # Fetch each Audit Log and delete it if hasn't been updated in 90 days
+    #
+    def collection
+      CommandJob.all
+    end
+
+    #
+    # Check which audit logs we wanted deleted
+    #
+    # Should be older than 90 days and either not a user model audit log or the model associated with
+    # the UserModelAuditLog has been deleted
+    #
+    def allowed_time_for_item(job)
+      job.ttl.days.ago.utc
+    rescue StandardError => error
+      App47Logger.log_warn "Unable to determine if job should be archived: #{job.inspect}", error
+      30.days.ago.utc
+    end
+  end
+end

data/lib/app/models/command_job.rb

@@ -0,0 +1,269 @@
+# frozen_string_literal: true
+
+#
+# Base class for all jobs that will be run on builds
+#
+class CommandJob
+  include StandardModel
+  #
+  # Constants
+  #
+  STATE_NEW = 'new' unless defined? STATE_NEW
+  STATE_WIP = 'working' unless defined? STATE_WIP
+  STATE_RETRYING = 'retrying' unless defined? STATE_RETRYING
+  STATE_SUCCESS = 'success' unless defined? STATE_SUCCESS
+  STATE_FAIL = 'failure' unless defined? STATE_FAIL
+  ALL_STATES = [STATE_NEW, STATE_WIP, STATE_RETRYING, STATE_SUCCESS, STATE_FAIL].freeze unless defined? ALL_STATES
+  #
+  # Fields
+  #
+  field :state, type: String, default: STATE_NEW
+  field :retries, type: Integer, default: 0
+  field :max_retries, type: Integer, default: 5
+  field :result, type: String
+  field :error_message, type: String
+  #
+  # Relationships
+  #
+  has_many :logs, class_name: 'JobLog', dependent: :destroy
+  #
+  # Validations
+  #
+  validates :state, inclusion: { in: ALL_STATES }
+
+  #
+  # Default time to keep a job before auto archiving it
+  #
+  def ttl
+    30
+  end
+
+  #
+  # Return the name of this job
+  #
+  def name
+    self.class.to_s.underscore.humanize
+  end
+
+  #
+  # True if in new status
+  #
+  def new?
+    STATE_NEW.eql?(state)
+  end
+
+  #
+  # True if in WIP status
+  #
+  def wip?
+    [STATE_RETRYING, STATE_WIP].include?(state)
+  end
+
+  #
+  # True if in success status
+  #
+  def success?
+    STATE_SUCCESS.eql?(state)
+  end
+
+  #
+  # True if in fail status
+  #
+  def fail?
+    STATE_FAIL.eql?(state)
+  end
+
+  #
+  # If we is finished, failed or success
+  #
+  def finished?
+    [STATE_FAIL, STATE_SUCCESS].include?(state)
+  end
+
+  #
+  # If we are still running
+  #
+  def running?
+    !finished?
+  end
+
+  #
+  # Return the job's status and information in a hash that could be used to return to a calling
+  # api
+  #
+  def status
+    status = { state: state }
+    status[:message] = error_message if error_message.present?
+    status
+  end
+
+  def perform
+    if fail?
+      self.retries = 0
+      self.error_message = 'Retrying'
+    end
+
+    begin
+      save!
+      run
+    rescue StandardError => error
+      log_error 'Unable to start job', error
+      set state: STATE_FAIL, error_message: error.message
+    end
+  end
+
+  def run
+    set state: STATE_WIP
+    # Run the job
+    run!
+    set error_message: '', state: STATE_SUCCESS
+  rescue StandardError => error
+    if retries >= max_retries
+      log_error "Unable to run job id: #{id}, done retrying", error
+      set state: STATE_FAIL, error_message: "Failed final attempt: #{error.message}"
+    else
+      log_error "Unable to run job id: #{id}, retrying!!", error
+      add_log "Unable to run job: #{error.message}, retrying!!"
+      set error_message: "Failed attempt # #{retries}: #{error.message}", retries: retries + 1
+      delay(run_at: 10.seconds.from_now).run
+    end
+  end
+
+  handle_asynchronously :run if Delayed::Worker.delay_jobs
+
+  #
+  # Determine the correct action to take and get it started
+  #
+  def run!
+    raise 'Incomplete class, concrete implementation should implement #run!'
+  end
+
+  #
+  # Write out the contents to the file
+  #
+  def write_file(path, contents)
+    File.open(path, 'w') { |f| f.write(contents) }
+    add_log "Saving:\n #{contents}\nto: #{path}"
+  end
+
+  #
+  # Download a file to the given path
+  #
+  def download_file(file_url, file_path)
+    download = URI.parse(file_url).open
+    IO.copy_stream(download, file_path)
+    add_log "Downloaded file: #{file_url} to #{file_path}"
+  end
+
+  #
+  # Copy a given file to a new location and record the log
+  #
+  def copy_file(from_path, to_path)
+    if File.exist? from_path
+      FileUtils.cp(from_path, to_path)
+      add_log "Copy file from: #{from_path} to: #{to_path}"
+    else
+      add_log "File not found: #{from_path}, copy not performed"
+    end
+  end
+
+  #
+  # Copy a given directory to a new location and record the log
+  #
+  def copy_dir(dir, to_path)
+    FileUtils.cp_r dir, to_path
+    add_log "Copy directory from: #{dir} to: #{to_path}"
+  end
+
+  #
+  # Remove the given file name
+  #
+  def remove_file(file_path)
+    return unless File.exist?(file_path)
+
+    FileUtils.remove_file file_path
+    add_log "Removing file: #{file_path}"
+  end
+
+  #
+  # Remove the given file name
+  #
+  def remove_dir(dir_path)
+    return unless File.exist?(dir_path)
+
+    FileUtils.remove_dir dir_path
+    add_log "Removing dir: #{dir_path}"
+  end
+
+  #
+  # Create a directory and record it
+  #
+  def mkdir(dir)
+    return if File.exist?(dir)
+
+    FileUtils.mkdir dir
+    add_log "Created directory: #{dir}"
+  end
+
+  alias make_dir mkdir
+
+  #
+  # Unzip a given file
+  #
+  def unzip_file(file_path, to_dir)
+    run_command "unzip #{file_path}", to_dir, error_texts: 'unzip:'
+  end
+
+  #
+  # Run the command capturing the command output and any standard error to the log.
+  #
+  def run_command(command, dir = '/tmp', options = {})
+    command = command.join(' ') if command.is_a?(Array)
+    output = Tempfile.open('run-command-', '/tmp') do |f|
+      Dir.chdir(dir) { `#{command} > #{f.path} 2>&1` }
+      mask_keywords(f.open.read, options[:mask_texts])
+    end
+    output = 'Success' if output.blank?
+    command = mask_keywords(command, options[:mask_texts])
+    CommandJobLog.create!(job: self, dir: dir, command: command, message: output)
+    check_for_text(output, options[:error_texts], true)
+    check_for_text(output, options[:required_texts], false)
+    output
+  end
+
+  #
+  # Mask keywords if given in the command
+  #
+  def mask_keywords(output, keywords = [])
+    return output if keywords.blank?
+
+    keywords = [keywords] if keywords.is_a?(String)
+    keywords.each do |keyword|
+      output = output.gsub(keyword, '***********')
+    end
+    output
+  end
+
+  #
+  # Check if any occurrences were found (or not found)
+  #
+  def check_for_text(output, texts = [], inclusive = true)
+    return if texts.blank?
+
+    texts = [texts] if texts.is_a?(String)
+    texts.each do |text|
+      if inclusive
+        raise "Error: found text (#{text}) - #{output}" if output.match?(/#{text}/)
+      else
+        raise "Error: missing text (#{text}) - #{output}" unless output.match?(/#{text}/)
+      end
+    end
+  end
+
+  #
+  # Add a job log message
+  #
+  def add_log(message)
+    JobLog.create!(job: self, message: message)
+  end
+end

data/lib/app/models/command_job_log.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+#
+# Capture command log messages for a given job
+#
+class CommandJobLog < JobLog
+  #
+  # Fields
+  #
+  field :command, type: String
+  field :dir, type: String
+  #
+  # Validations
+  #
+  validates :command, presence: true
+
+  #
+  # Display message
+  #
+  def display_message
+    "Dir: #{dir}\nCommand: #{command}\nOutput: #{message}"
+  end
+end

data/lib/app/models/job_log.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+#
+# Capture log messages for a given job
+#
+class JobLog
+  include StandardModel
+  #
+  # Fields
+  #
+  field :message, type: String
+  #
+  # Relationships
+  #
+  belongs_to :job, inverse_of: :logs, class_name: 'CommandJob'
+  #
+  # Validations
+  #
+  validates :message, presence: true
+
+  #
+  # Display message
+  #
+  def display_message
+    message
+  end
+end

data/lib/web47command.rb

@@ -0,0 +1,8 @@
+require 'web47command/version'
+require 'app/models/job_log'
+require 'app/models/command_job_log'
+require 'app/models/command_job'
+#
+# Cron
+#
+require 'app/jobs/cron/trim_jobs'

data/lib/web47command/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Web47command
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,343 @@
+--- !ruby/object:Gem::Specification
+name: web47command
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Schroeder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: web47core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: codacy-coverage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: listen
+  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: 5.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.10.3
+- !ruby/object:Gem::Dependency
+  name: minitest-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest-rails-capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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: mocha
+  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: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: vcr
+  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: webmock
+  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: Support the execution and recordation of running commands in a shell
+email:
+- chris@app47.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/app/jobs/cron/trim_jobs.rb
+- lib/app/models/command_job.rb
+- lib/app/models/command_job_log.rb
+- lib/app/models/job_log.rb
+- lib/web47command.rb
+- lib/web47command/version.rb
+homepage: https://app47.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.4.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: App47 Web Command Library.
+test_files: []