jackal 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aad960864456381c1973a63d0410dea7200be1fc
-  data.tar.gz: 43787842bebae529547b90613402f0f84f77eab0
+  metadata.gz: 765568d3e3823dc7b7ebbc36532af60b3fa16cbb
+  data.tar.gz: 8029a241f1207de9f34d0ff8dad9412c02a8d3e6
 SHA512:
-  metadata.gz: 3edc50f45995b3154e0c6726b85c44a41403ef3b4f7a020321a802a29a076c9ef5a7fee9af6596f15d2272fa92273d4057a9ab917ac3228720f03f270733b217
-  data.tar.gz: 46d2b9a99c0fac02cbd7bff500b840a778389b3484d867df4ee1d5fe3db9624a22f78c4a4baeeb422f446a3a7cbb261e982def6c3191252bc148b35fed109751
+  metadata.gz: 05cc094b95877e7b0f11438f11d55a2a3e4a05c45a99d67002a4006533defe935d1cb533303f10c26b539c766449e98d0ec7c2b484cc022e5cd6c5826f97a823
+  data.tar.gz: 5d54e7aa1462f7685dd574212bd727b22e417b8075178951f7d86cb184cd4c4f1e339daf36c3b0ab2fa8dcc0c783b704f47dbe9b21ddb441195e918b5ec32b78

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.3.4
+* Scrub environment prior to shelling out
+* Add service registration helper
+* Extract payload directly if provided via source
+
 # v0.3.2
 * Add support for `pre` and `post` formatters
 

data/jackal.gemspec

@@ -10,9 +10,10 @@ Gem::Specification.new do |s|
   s.description = 'Message processing helper'
   s.require_path = 'lib'
   s.license = 'Apache 2.0'
-  s.add_dependency 'carnivore', '>= 0.3.0', '< 1.0.0'
+  s.add_dependency 'carnivore', '>= 0.3.12', '< 1.0.0'
+  s.add_dependency 'bogo', '>= 0.1.24', '< 1.0.0'
   s.add_dependency 'bogo-cli', '~> 0.1'
-  s.add_dependency 'bogo-config', '>= 0.1.6', '< 1.0.0'
+  s.add_dependency 'bogo-config', '>= 0.1.20', '< 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'

data/lib/jackal.rb

@@ -1,4 +1,5 @@
 require 'carnivore'
+require 'bogo-config'
 
 module Jackal
   autoload :Cli, 'jackal/cli'
@@ -7,6 +8,57 @@ module Jackal
   autoload :Formatter, 'jackal/formatter'
   autoload :Utils, 'jackal/utils'
   autoload :Loader, 'jackal/loader'
+
+  class ServiceInformation < Bogo::Config
+    class Configuration < Bogo::Config
+      attribute :name, Symbol, :required => true, :coerce => lambda{|v| v.to_sym}
+      attribute :type, Symbol, :required => true, :default => :string, :allowed_values => [:string, :hash, :number, :boolean]
+      attribute :description, String
+      attribute :public, [TrueClass, FalseClass], :default => true, :required => true
+    end
+
+    attribute :name, Symbol, :required => true, :coerce => lambda{|v| v.to_sym}
+    attribute :description, String
+    attribute :configuration, Configuration, :multiple => true, :default => [], :coerce => lambda{|v|
+      Smash.new(
+        :bogo_multiple => v.map{|name, hsh|
+          Configuration.new(hsh.merge(:name => name))
+        }
+      )
+    }
+  end
+
+  # Add service information
+  #
+  # @param name [String, Symbol] name of service
+  # @param args [Hash] service information
+  # @option args [String] :description
+  # @option args [Hash] :configuration
+  # @return [NilClass]
+  def self.service(name, args={})
+    name = name.to_s
+    if(@services[name])
+      new_config = ServiceInformation.new(args.merge(:name => name))
+      @services[name] = ServiceInformation.new(
+        @services[name].data.merge(
+          :configuration => (
+            @services[name].data[:configuration] |
+            new_config.data[:configuration]
+          )
+        )
+      )
+    else
+      @services[name] = ServiceInformation.new(args.merge(:name => name))
+    end
+    nil
+  end
+
+  # @return [Smash] registered service info
+  def self.service_info
+    @services.to_smash
+  end
+
+  @services = Smash.new
 end
 
 require 'jackal/version'

data/lib/jackal/utils/payload.rb

@@ -25,8 +25,12 @@ module Jackal
       # @param message [Carnivore::Message]
       # @return [Smash]
       def unpack(message)
-        msg = message[:message].to_smash
-        result = msg.fetch(:payload, msg)
+        if(message[:content])
+          result = message[:content].to_smash
+        else
+          msg = message[:message].to_smash
+          result = msg.fetch(:payload, msg)
+        end
         if(respond_to?(:pre_formatters) && (pre_formatters && !pre_formatters.empty?))
           pre_formatters.each do |formatter|
             begin

data/lib/jackal/utils/process.rb

@@ -11,6 +11,9 @@ module Jackal
       # Default path for IO tmp files
       DEFAULT_STORAGE_DIRECTORY = '/tmp/jackal-process-manager'
 
+      # Environment variables that should be removed from process environment
+      BLACKLISTED_ENV = ['GIT_DIR']
+
       # @return [Smash] manager configuration
       attr_reader :configuration
       # @return [String] storage directory path
@@ -21,6 +24,7 @@ module Jackal
       # @param config [Smash] process manager configuration
       # @return [self]
       def initialize(config={})
+        @base_env = ENV.to_hash
         @configuration = config.to_smash
         @storage_directory = configuration.fetch(
           :storage_directory, DEFAULT_STORAGE_DIRECTORY
@@ -33,21 +37,26 @@ module Jackal
       # @param identifier [String] command identifier (compat argument)
       # @param command [String] command in single string or splatted array
       # @yieldparam [ChildProcess]
-      # @return [TrueClass]
+      # @return [ChildProcess] allows for result inspection if desired
       def process(identifier, *command)
+        _proc = nil
         if(command.size == 1)
           command = Shellwords.shellsplit(command.first)
         end
         if(block_given?)
           if(configuration[:spawn])
-            yield ChildProcess::Unix::PosixSpawnProcess.new(command)
+            _proc = clean_env!{ ChildProcess::Unix::PosixSpawnProcess.new(command) }
+            scrub_env(_proc.environment)
+            clean_env!{ yield _proc }
           else
-            yield ChildProcess.build(*command)
+            _proc = clean_env!{ ChildProcess.build(*command) }
+            scrub_env(_proc.environment)
+            clean_env!{ yield _proc }
           end
         else
           raise ArgumentError.new('Expecting block but no block provided!')
         end
-        true
+        _proc
       end
 
       # Temporary IO for logging
@@ -62,6 +71,37 @@ module Jackal
         t_file
       end
 
+      private
+
+      # Remove environment variables that are known should _NOT_ be set
+      #
+      # @yield execute block within scrubbed environment
+      def clean_env!
+        ENV.replace(@base_env.dup)
+        scrub_env(ENV)
+        if(defined?(Bundler))
+          Bundler.with_clean_env{ yield }
+        else
+          yield
+        end
+      end
+
+      # Scrubs configured keys from hash
+      #
+      # @param env [Hash] hash to scrub
+      # @return [TrueClass]
+      def scrub_env(env)
+        [
+          BLACKLISTED_ENV,
+          Carnivore::Config.get(
+            :jackal, :utils, :process_manager, :blacklisted_env
+          )
+        ].flatten.compact.each do |key|
+          env.delete(key)
+        end
+        true
+      end
+
     end
   end
 end

data/lib/jackal/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackal
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-04 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carnivore
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.12
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -26,7 +26,27 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.12
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bogo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.24
+    - - "<"
+      - !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.1.24
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -50,7 +70,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.20
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -60,7 +80,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.20
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -136,4 +156,3 @@ signing_key:
 specification_version: 4
 summary: Message processing helper
 test_files: []
-has_rdoc: