jackal-commander 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1efecf35ee306e288645dd49c8a37275fb57327
+  data.tar.gz: 6be1982db812ed0ea02f96d7f76c98b51cbb5652
+SHA512:
+  metadata.gz: c6e383a25524b9b2c6d908f959c9b07de814b9e5b4f7ea06dda59cab1d34eaf78d9d329fdb2a7e5311d8678e6bab7a7dfa63b27ce23eea3184e55eae1bc67be4
+  data.tar.gz: 555dfde9a2c74d55c2fa264d63649f49ebfb81baaf2037a22b6930ee23b10c2d0b8de4cfd9b9dec65afad9b25aca08c076fc46fb5952b5b83e0a76af9894a0f8

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# v0.1.0
+* Initial commit

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+## Branches
+
+### `master` branch
+
+The master branch is the current stable released version.
+
+### `develop` branch
+
+The develop branch is the current edge of development.
+
+## Pull requests
+
+* https://github.com/carnivore-rb/jackal-commander/pulls
+
+Please base all pull requests of the `develop` branch. Merges to
+`master` only occur through the `develop` branch. Pull requests
+based on `master` will likely be cherry picked.
+
+## Issues
+
+Need to report an issue? Use the github issues:
+
+* https://github.com/carnivore-rb/jackal-commander/issues

data/LICENSE

@@ -0,0 +1,13 @@
+   Copyright 2014 Chris Roberts
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,92 @@
+# Jackal Commander
+
+Execute actions via jackal
+
+## Usage
+
+Set action to execute within payload:
+
+
+### Single action
+
+```json
+{
+  ...
+  "data": {
+    "commander": {
+      "action": "toucher"
+    }
+  }
+}
+```
+
+### Multiple actions
+
+
+```json
+{
+  ...
+  "data": {
+    "commander": {
+      "actions": [
+        "toucher",
+        "remover"
+      ]
+    }
+  }
+}
+```
+
+### Mixed actions
+
+```json
+{
+  ...
+  "data": {
+    "commander": {
+      "action": "toucher",
+      "actions": [
+        "remover"
+      ]
+    }
+  }
+}
+```
+
+### With extra arguments
+
+```json
+{
+  ...
+  "data": {
+    "commander": {
+      "action": {
+        "name": "custom_touch",
+        "arguments": "/tmp/my-custom-file"
+      }
+    }
+  }
+}
+```
+
+## Configuration
+
+Define the action within the configuration:
+
+```json
+{
+  ...
+  "config": {
+    "actions": {
+      "toucher": "touch /tmp/test-file",
+      "remover": "rm -f /tmp/test-file",
+      "custom_touch": "touch"
+    }
+  }
+}
+```
+
+## Info
+
+* Repository: https://github.com/carnviore-rb/jackal-cfn
+* IRC: Freenode @ #carnivore

data/jackal-commander.gemspec

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
+require 'jackal-commander/version'
+Gem::Specification.new do |s|
+  s.name = 'jackal-commander'
+  s.version = Jackal::Commander::VERSION.version
+  s.summary = 'Message processing helper'
+  s.author = 'Chris Roberts'
+  s.email = 'code@chrisroberts.org'
+  s.homepage = 'https://github.com/carnivore-rb/jackal-commander'
+  s.description = 'Command helpers'
+  s.require_path = 'lib'
+  s.license = 'Apache 2.0'
+  s.add_dependency 'jackal'
+  s.add_dependency 'childprocess'
+  s.files = Dir['lib/**/*'] + %w(jackal-commander.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
+end

data/lib/jackal-commander/executor.rb

@@ -0,0 +1,96 @@
+require 'jackal-commander'
+
+module Jackal
+  module Commander
+    # Run executions
+    class Executor < Jackal::Callback
+
+      # @return [String] root path for process output files
+      attr_reader :process_output_root
+
+      # default temp storage directory for process outputs
+      DEFAULT_PROCESS_OUTPUT_ROOT = '/tmp/jackal-executor'
+
+      # Setup the callback
+      def setup(*_)
+        require 'shellwords'
+        require 'tempfile'
+        require 'childprocess'
+        require 'fileutils'
+        @process_output_root = config.fetch(:process_output_root, DEFAULT_PROCESS_OUTPUT_ROOT)
+        FileUtils.mkdir_p(process_output_root)
+      end
+
+      # Determine validity of message
+      #
+      # @param message [Carnivore::Message]
+      # @return [Truthy, Falsey]
+      def valid?(message)
+        super do |payload|
+          payload.get(:data, :commander, :action) ||
+            payload.get(:data, :commander, :actions)
+        end
+      end
+
+      # Execute requested action
+      #
+      # @param message [Carnivore::Message]
+      def execute(message)
+        failure_wrap(message) do |payload|
+          actions = [
+            payload.get(:data, :commander, :action),
+            payload.get(:data, :commander, :actions)
+          ].flatten.compact.uniq
+          cmds = actions.map do |action|
+            if(action.is_a?(Hash))
+              extra_args = action[:arguments]
+              action = action[:name]
+            else
+              extra_args = ''
+            end
+            if(cmd = config.get(:actions, action))
+              debug "Action maps to command: #{cmd.inspect}"
+              [action, cmd, extra_args]
+            else
+              error "No command mapping configured for requested action: #{action}"
+              raise KeyError.new("Invalid command mapping. Key not found: `#{action}`")
+            end
+          end
+          results = cmds.map do |action, command, extra_args|
+            if(extra_args.is_a?(String))
+              command = "#{command} #{extra_args}"
+            end
+            cmd_input = Shellwords.shellsplit(command)
+            if(extra_args.is_a?(Array))
+              cmd_input += extra_args
+            end
+            process = ChildProcess.build(*cmd_input)
+            stdout = File.open(File.join(process_output_root, [payload[:id], 'stdout'].join('-')), 'w+')
+            stderr = File.open(File.join(process_output_root, [payload[:id], 'stderr'].join('-')), 'w+')
+            process.io.stdout = stdout
+            process.io.stderr = stderr
+            debug "Running requested action: #{action} (#{command})"
+            process.start
+            debug "Process started. Waiting for process completion (#{action})"
+            status = process.wait
+            stdout.rewind
+            stderr.rewind
+            if(status == 0)
+              info "Successfully executed action: #{action}"
+              info "STDOUT (#{action}): #{stdout.read.gsub("\n", '')}"
+            else
+              error "Failed to successfully execute action: #{action}"
+              error "Failed action exit code (#{action}): #{process.exit_code}"
+              error "STDOUT (#{action}): #{stdout.read.gsub("\n", '')}"
+              error "STDERR (#{action}): #{stderr.read.gsub("\n", '')}"
+            end
+            [action, {:exit_code => process.exit_code}]
+          end
+          payload.set(:data, :commander, :results, results)
+          job_completed(:commander, payload, message)
+        end
+      end
+
+    end
+  end
+end

data/lib/jackal-commander/version.rb

@@ -0,0 +1,6 @@
+module Jackal
+  module Commander
+    # Current library version
+    VERSION = Gem::Version.new('0.1.0')
+  end
+end

data/lib/jackal-commander.rb

@@ -0,0 +1,8 @@
+require 'jackal'
+require 'jackal-commander/version'
+
+module Jackal
+  module Commander
+    autoload :Executor, 'jackal-commander/executor'
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: jackal-commander
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jackal
+  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: childprocess
+  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'
+description: Command helpers
+email: code@chrisroberts.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- jackal-commander.gemspec
+- lib/jackal-commander.rb
+- lib/jackal-commander/executor.rb
+- lib/jackal-commander/version.rb
+homepage: https://github.com/carnivore-rb/jackal-commander
+licenses:
+- Apache 2.0
+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: Message processing helper
+test_files: []
+has_rdoc: