jackal 0.1.16 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 238f64730bc68ab50fe7f24e2de11f5e07a084ec
-  data.tar.gz: 305ba06c52248d48f704965d33494cdaffe82715
+  metadata.gz: 914f2d57a1083c0adc67afe2bda1f310201779bd
+  data.tar.gz: 2323ad17173d7dd0d2325cdd36de6399abc42fca
 SHA512:
-  metadata.gz: acc58c09217457638e88ff5486bce667630d1d568fde6b79a88bafdf7702235162a5d42386524c445d9f9a5491c781e9276127bd835a6e28239bb2f6933997ad
-  data.tar.gz: 70c6d38554e1ead5e410ece8896cee42cd34f35aec97297afa7f97705b60c048b7a7bc86a1eb6fd10217e412829a38b89a92cf8056ae420a0a9d03afaa72607f
+  metadata.gz: ba7be9cc5ad19e6ddf23086226291f7cda5b58efea577309d52b4bf17ed39408e5a3ace5ac8ed01391fe1eab16b33675fbaa988472d8d4a9340e75d04b559755
+  data.tar.gz: e09419edd04c3f59efa6f41c9e0d4579e61480c77a8d5f98545aaea15e5e4251fa0c0607cca15be0e147d24aeeb79b23800385d314f8fbdc3206df509d76d5d2

data/CHANGELOG.md

@@ -1,6 +1,11 @@
+# v0.2.0
+* Add abstract payload formatter
+* Provide common helper method to shell out
+* Remove custom CLI and integrate bogo-cli
+
 # v0.1.16
 * Load HTTP hook directly prior to service start
-  * Fixes some issues with spec loads
+* Fixes some issues with spec loads
 
 # v0.1.14
 * Move orphan handlers into source init arg

data/bin/jackal

@@ -1,3 +1,18 @@
 #!/usr/bin/env ruby
+require 'bogo-cli'
 require 'jackal'
-require 'jackal/loader'
+
+Bogo::Cli::Setup.define do
+
+  on :v, :version, 'Print version' do
+    puts "jackal - Message Pipeline - [Version: #{Jackal::VERSION}]"
+    exit
+  end
+  on :c, :config=, 'Configuration file or directory'
+  on :V, :verbosity=, 'Log verbosity (debug info warn error)'
+  run do |opts, args|
+    Jackal::Loader.run!(opts)
+    exit
+  end
+
+end

data/jackal.gemspec

@@ -10,9 +10,11 @@ Gem::Specification.new do |s|
   s.description = 'Message processing helper'
   s.require_path = 'lib'
   s.license = 'Apache 2.0'
-  s.add_dependency 'carnivore', '>= 0.2.6'
-  s.add_dependency 'mixlib-cli'
-  s.files = Dir['lib/**/*'] + %w(jackal.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
+  s.add_dependency 'carnivore', '>= 0.3.0', '< 1.0.0'
+  s.add_dependency 'bogo-cli', '~> 0.1'
+  s.add_dependency 'bogo-config', '>= 0.1.6', '< 1.0.0'
+  s.add_dependency 'childprocess'
+  s.files = Dir['{lib,bin}/**/**/*'] + %w(jackal.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
   s.executables << 'jackal'
   s.executables << 'jackal-test'
 end

data/lib/jackal.rb

@@ -4,7 +4,9 @@ module Jackal
   autoload :Cli, 'jackal/cli'
   autoload :Callback, 'jackal/callback'
   autoload :Error, 'jackal/error'
+  autoload :Formatter, 'jackal/formatter'
   autoload :Utils, 'jackal/utils'
+  autoload :Loader, 'jackal/loader'
 end
 
 require 'jackal/version'

data/lib/jackal/callback.rb

@@ -6,8 +6,33 @@ module Jackal
 
     include Utils::Payload
     include Utils::Config
+    include Utils::Config
     # @!parse include Jackal::Utils::Payload
     # @!parse include Jackal::Utils::Config
+    # @!parse include Jackal::Utils::Constants
+
+    # @return [Array<Formatter>] formatters
+    attr_reader :formatters
+
+    # Create new instance
+    #
+    # @return [self]
+    def initialize(*_)
+      super
+      if(service_config[:formatters])
+        @formatters = service_config[:formatters].map do |klass_name|
+          constantize(klass_name).new
+        end
+      end
+    end
+
+    # @return [Utils::Process]
+    def process_manager
+      unless(@_process)
+        @_process = Utils::Process.new
+      end
+      @_process
+    end
 
     # Validity of message
     #
@@ -86,9 +111,22 @@ module Jackal
     # @param message [Carnivore::Message]
     def job_completed(name, payload, message)
       info "Processing of message #{message} has completed within this component #{name}"
+      if(formatters)
+        apply_formatters!(payload)
+      end
       message.confirm!
       forward(payload)
     end
 
+    # Apply configured formatters to payload
+    #
+    # @param payload [Smash]
+    # @return [Smash]
+    def apply_formatters!(payload)
+      formatters.each do |formatter|
+        formatter.format(payload)
+      end
+    end
+
   end
 end

data/lib/jackal/formatter.rb

@@ -0,0 +1,56 @@
+require 'jackal'
+
+module Jackal
+  # Payload formatter
+  class Formatter
+
+    class << self
+
+      # Register formatter
+      def inherited(klass)
+        Formatter.descendants.push(klass).uniq!
+      end
+
+      # @return [Array<Class>] registered formatters
+      def descendants
+        @_descendants ||= []
+      end
+
+    end
+
+    # @return [String, Symbol]
+    SOURCE = nil
+    # @return [String, Symbol]
+    DESTINATION = nil
+
+    # Create a new instance
+    #
+    # @return [self]
+    def initialize
+      [:SOURCE, :DESTINATION].each do |key|
+        unless(self.class.const_get(key))
+          raise NotImplementedError.new("Formatter class must define #{key} constant")
+        end
+      end
+    end
+
+    # @return [Symbol]
+    def source
+      self.class.const_get(:SOURCE).to_sym
+    end
+
+    # @return [Symbol]
+    def destination
+      self.class.const_get(:DESTINATION).to_sym
+    end
+
+    # Apply format to payload
+    #
+    # @param payload [Smash]
+    # @return payload [Smash]
+    def format(payload)
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/jackal/loader.rb

@@ -1,57 +1,68 @@
 require 'carnivore'
 require 'jackal'
 
-unless(ENV['JACKAL_TESTING_MODE'])
-  cli = Jackal::Cli.new
-  cli.parse_options
-  Carnivore::Config.configure(cli.config)
-end
+module Jackal
+  class Loader
+    class << self
+
+      # Run the jackal
+      #
+      # @param opts [Hash]
+      def run!(opts)
 
-Carnivore::Config.auto_symbolize(true)
+        if(ENV['JACKAL_TESTING_MODE'] && !opts[:config])
+          Carnivore.configure!(:verify)
+        else
+          Carnivore.configure!(opts[:config])
+          Carnivore::Config.immutable!
+        end
 
-Celluloid.logger.level = Celluloid.logger.class.const_get(
-  (Carnivore::Config.get(:verbosity) || :debug).to_s.upcase
-)
+        Celluloid.logger.level = Celluloid.logger.class.const_get(
+          (opts[:verbosity] || Carnivore::Config[:verbosity] || :debug).to_s.upcase
+        )
 
-(Carnivore::Config.get(:jackal, :require) || []).each do |path|
-  require path
-end
+        Carnivore::Config.fetch(:jackal, :require, []).each do |path|
+          require path
+        end
 
-begin
-  Carnivore::Utils.symbolize_hash(Carnivore::Config.hash_dup).each do |namespace, args|
-    next unless args.is_a?(Hash)
-    args.each do |key, opts|
-      next unless opts.is_a?(Hash) && opts[:sources]
-      Carnivore::Utils.debug "Processing: #{opts.inspect}"
-      Carnivore.configure do
-        opts.fetch(:sources, {}).each do |kind, source_args|
-          source = Carnivore::Source.build(
-            :type => source_args[:type].to_sym,
-            :args => source_args.fetch(:args, {}).merge(:name => "#{namespace}_#{key}_#{kind}"),
-            :orphan_callback => lambda{|message|
-              error "No callbacks matched message. Failed to process. Removed from bus. (#{message})"
-              message.confirm!
-            }
-          )
-          Carnivore::Utils.info "Registered new source: #{namespace}_#{key}_#{kind}"
-          if(kind == :input)
-            opts.fetch(:callbacks, []).each do |klass_name|
-              klass = klass_name.split('::').inject(Object) do |memo, name|
-                memo.const_get(name)
+        begin
+          Carnivore::Config.to_smash.each do |namespace, args|
+            next unless args.is_a?(Hash)
+            args.each do |key, opts|
+              next unless opts.is_a?(Hash) && opts[:sources]
+              Carnivore::Utils.debug "Processing: #{opts.inspect}"
+              Carnivore.configure do
+                opts.fetch(:sources, {}).each do |kind, source_args|
+                  source = Carnivore::Source.build(
+                    :type => source_args[:type].to_sym,
+                    :args => source_args.fetch(:args, {}).merge(:name => "#{namespace}_#{key}_#{kind}"),
+                    :orphan_callback => lambda{|message|
+                      error "No callbacks matched message. Failed to process. Removed from bus. (#{message})"
+                      message.confirm!
+                    }
+                  )
+                  Carnivore::Utils.info "Registered new source: #{namespace}_#{key}_#{kind}"
+                  if(kind == :input)
+                    opts.fetch(:callbacks, []).each do |klass_name|
+                      klass = Utils.constantize(klass_name)
+                      source.add_callback(klass_name, klass)
+                    end
+                  end
+                end
               end
-              source.add_callback(klass_name, klass)
             end
           end
+          Jackal::Utils.load_http_hook
+          Carnivore.start!
+        rescue => e
+          $stderr.puts "Unexpected failure encountered: #{e.class}: #{e}"
+          if(ENV['DEBUG'])
+            $stderr.puts "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"
+          end
+          exit -1
         end
+
       end
     end
   end
-  Jackal::Utils.load_http_hook
-  Carnivore.start!
-rescue => e
-  $stderr.puts "Unexpected failure encountered: #{e.class}: #{e}"
-  if(ENV['DEBUG'])
-    $stderr.puts "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"
-  end
-  exit -1
 end

data/lib/jackal/utils.rb

@@ -7,9 +7,12 @@ module Jackal
     autoload :Spec, 'jackal/utils/spec'
     autoload :Payload, 'jackal/utils/payload'
     autoload :Config, 'jackal/utils/config'
+    autoload :Constants, 'jackal/utils/constants'
     autoload :HttpApi, 'jackal/utils/http_api'
+    autoload :Process, 'jackal/utils/process'
 
     extend Payload
+    extend Constants
 
     class << self
 

data/lib/jackal/utils/config.rb

@@ -4,6 +4,11 @@ module Jackal
   module Utils
     module Config
 
+      # @return [Symbol] name of service
+      def service_name(class_name = self.class.name)
+        config_path(class_name).last.to_sym
+      end
+
       # @return [Array] key path in configuration
       def config_path(class_name = self.class.name)
         class_name.split('::')[0,2].map do |string|
@@ -16,9 +21,14 @@ module Jackal
         config_path.join('_')
       end
 
-      # @return [Hash] configuration
+      # @return [Smash] service configuration
+      def service_config
+        Carnivore::Config.get(*config_path) || Smash.new
+      end
+
+      # @return [Smash] configuration
       def config
-        Carnivore::Config.get(*config_path.push(:config)) || Smash.new
+        service_config[:config] || Smash.new
       end
 
       # Generation destination key based on direction

data/lib/jackal/utils/constants.rb

@@ -0,0 +1,19 @@
+require 'jackal'
+
+module Jackal
+  module Utils
+    module Constants
+
+      # Provide constant defined by string
+      #
+      # @param string [String] constant to locate
+      # @return [Class]
+      def constantize(string)
+        klass = string.to_s.split('::').inject(Object) do |memo, name|
+          memo.const_get(name)
+        end
+      end
+
+    end
+  end
+end

data/lib/jackal/utils/process.rb

@@ -0,0 +1,52 @@
+require 'jackal'
+require 'fileutils'
+require 'childprocess'
+require 'shellwords'
+require 'tempfile'
+
+module Jackal
+  module Utils
+    class Process
+
+      # Create new instance
+      #
+      # @return [self]
+      def initialize
+        @storage_directory = Carnivore::Config.fetch(
+          :fission, :utils, :process_manager, :storage,
+          '/tmp/fission/process_manager'
+        )
+        FileUtils.mkdir_p(@storage_directory)
+      end
+
+      # Create new process
+      #
+      # @param identifier [String] command identifier (compat argument)
+      # @param command [String] command in single string or splatted array
+      # @yieldparam [ChildProcess]
+      # @return [TrueClass]
+      def process(identifier, *command)
+        if(command.size == 1)
+          command = Shellwords.shellsplit(command.first)
+        end
+        if(block_given?)
+          yield ChildProcess.build(*command)
+        end
+        true
+      end
+
+      # Temporary IO for logging
+      #
+      # @param args [String] argument list joined for filename
+      # @return [IO]
+      def create_io_tmp(*args)
+        path = File.join(@storage_directory, args.join('-'))
+        FileUtils.mkdir_p(File.dirname(path))
+        t_file = File.open(path, 'w+')
+        t_file.sync
+        t_file
+      end
+
+    end
+  end
+end

data/lib/jackal/utils/spec/helpers.rb

@@ -55,10 +55,9 @@ end
 # @return [Thread] thread with running source
 def run_setup(config)
   path = File.join(Dir.pwd, 'test/specs/config', "#{config}.json")
-  Carnivore::Config.configure(:config_path => path)
   Thread.abort_on_exception = true
   runner = Thread.new do
-    require 'jackal/loader'
+    Jackal::Loader.run!(:config => path)
   end
   source_wait(:setup)
   runner

data/lib/jackal/utils/spec/loader.rb

@@ -1,5 +1,3 @@
-require 'carnivore/config'
-
 ENV['JACKAL_TESTING_MODE'] = 'true'
 
 path = File.join(Dir.pwd, 'test')

data/lib/jackal/version.rb

@@ -1,4 +1,4 @@
 module Jackal
   # Current library version
-  VERSION = Gem::Version.new('0.1.16')
+  VERSION = Gem::Version.new('0.2.0')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackal
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2015-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carnivore
@@ -16,16 +16,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bogo-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bogo-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.1.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: mixlib-cli
+  name: childprocess
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -57,11 +97,14 @@ files:
 - lib/jackal/callback.rb
 - lib/jackal/cli.rb
 - lib/jackal/error.rb
+- lib/jackal/formatter.rb
 - lib/jackal/loader.rb
 - lib/jackal/utils.rb
 - lib/jackal/utils/config.rb
+- lib/jackal/utils/constants.rb
 - lib/jackal/utils/http_api.rb
 - lib/jackal/utils/payload.rb
+- lib/jackal/utils/process.rb
 - lib/jackal/utils/spec.rb
 - lib/jackal/utils/spec/callback_local.rb
 - lib/jackal/utils/spec/helpers.rb