pdi 1.0.0.pre.alpha → 1.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7934ad85a3ff2d1c40beb617ca4d1d0ad24aaa3b937bb09409836ef12b245f06
-  data.tar.gz: d4a096374986562781a18905a8e9ea64039750f22e82e3b67d386143c31b2915
+  metadata.gz: e653f6aed9fd26cce60e4f84cfdf662e0be847f40828142dd28fcc6118150cc7
+  data.tar.gz: 6ab7d8da5c628dc867d0607bcb3a3db6a5b4c030f07d91adc3f47516a2b3350f
 SHA512:
-  metadata.gz: c3f8ecf38e493e95100bfba8e92da5c344e629b89268c484ddb03834f32e8627e150e54705ca034176c63255c29db87c2b87b2ded8a5daf9033b161e57bdef5e
-  data.tar.gz: 0b299a6e8466c26de5c9dfada312beaae2a171c913b35dcba06ad2d34fb7a5cb9a82f1d48bd972bc08912acffed6f4e4941ad2665ab5a80fe6add18bacb71d00
+  metadata.gz: 2e2688a153fea7a256e80a9e682b6488e71923d2752e32f37c23a39c7899f33faf2ffd99c91b5770e4e4279dd0af0ea9f3bdd6d52057b9780d6f798f7a44fedc
+  data.tar.gz: 66f618cc1203d313091cd849403501c127907a719f2b6503792cffe606f02062d0f2f31e179a45395e4460c47245de5461c1b78496208ad5ddf68437f7889558

data/README.md

@@ -1,4 +1,4 @@
-# PDI
+# Pdi
 
 ---
 
@@ -36,14 +36,14 @@ Pull Requests are welcome for:
 
 ## Examples
 
-All examples assume PDI has been installed to your home directory: `~/data-integration`.
+All examples assume Pdi has been installed to your home directory: `~/data-integration`.
 
 ### Creating a Spoon Instance
 
-`PDI::Spoon` is the common interface you will use when interacting with PDI.  It will use Pan and Kitchen for executing Spoon commands.
+`Pdi::Spoon` is the common interface you will use when interacting with Pdi.  It will use Pan and Kitchen for executing Spoon commands.
 
 ```ruby
-spoon = PDI::Spoon.new(dir: `~/data-integration`)
+spoon = Pdi::Spoon.new(dir: `~/data-integration`)
 ```
 
 Note: You can also override the names of the scripts using the `kitchen` and `pan` constructor keyword arguments.  The defaults are `kitchen.sh` and `pan.sh`, respectively.
@@ -52,7 +52,7 @@ Note: You can also override the names of the scripts using the `kitchen` and `pa
 
 ```ruby
 options = {
-  level: PDI::Spoon::Level::DETAILED,
+  level: Pdi::Spoon::Level::DETAILED,
   name: 'update_address',
   repository: 'transformations/demographics',
   params: {
@@ -66,12 +66,12 @@ result = spoon.run(options)
 
 `Spoon#run` will return:
 
-* `PDI::Spoon::Result` upon a successful run.
-* If a non-zero exit code was returned then a `PDI::Spoon::PanError` or `PDI::Spoon::KitchenError` will be raised.
+* `Pdi::Spoon::Result` upon a successful run.
+* If a non-zero exit code was returned then a `Pdi::Spoon::PanError` or `Pdi::Spoon::KitchenError` will be raised.
 
 You can access the raw command line results by tapping into the execution attribute of the result or error object.
 
-Note: Not all options are currently supported.  See PDI's official references for [Pan](https://help.pentaho.com/Documentation/6.1/0L0/0Y0/070/000) and [Kitchen](https://help.pentaho.com/Documentation/6.1/0L0/0Y0/070/010) to see all options.
+Note: Not all options are currently supported.  See Pdi's official references for [Pan](https://help.pentaho.com/Documentation/6.1/0L0/0Y0/070/000) and [Kitchen](https://help.pentaho.com/Documentation/6.1/0L0/0Y0/070/010) to see all options.
 
 ## Contributing
 

data/lib/pdi/executor/result.rb

@@ -7,20 +7,22 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-module PDI
+require_relative 'status'
+
+module Pdi
   class Executor
     # General return object for an execution call result.
     class Result
-      attr_reader :cmd,
-                  :code,
-                  :out_and_err,
-                  :pid
+      extend Forwardable
+      acts_as_hashable
+
+      attr_reader :args, :status
+
+      def_delegators :status, :code, :out, :err, :pid
 
-      def initialize(cmd, code, out_and_err, pid)
-        @cmd         = cmd
-        @code        = code
-        @out_and_err = out_and_err
-        @pid         = pid
+      def initialize(args:, status: {})
+        @args   = args
+        @status = Status.make(status)
 
         freeze
       end

data/lib/pdi/executor/status.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Pdi
+  class Executor
+    # General return object for describing the operating system return data.
+    class Status
+      acts_as_hashable
+
+      attr_reader :code, :out, :err, :pid
+
+      def initialize(code:, out: '', err: '', pid:)
+        @code = code
+        @out  = out
+        @err  = err
+        @pid  = pid
+
+        freeze
+      end
+    end
+  end
+end

data/lib/pdi/executor.rb

@@ -9,22 +9,24 @@
 
 require_relative 'executor/result'
 
-module PDI
+module Pdi
   # This class is the library's "metal" layer, the one which actually makes the system call and
   # interacts with the operating system (through Ruby's standard library.)
   class Executor
-    SPACE = ' '
+    def run(args)
+      args = Array(args).map(&:to_s)
 
-    def run(*args)
-      cmd = args.flatten.join(SPACE)
+      out, err, status = Open3.capture3(*args)
 
-      Open3.popen2e(cmd) do |_stdin, stdout_and_stderr, wait_thr|
-        pid         = wait_thr.pid
-        code        = wait_thr.value.to_s.split(SPACE).last.to_i
-        out_and_err = stdout_and_stderr.read
-
-        Result.new(cmd, code, out_and_err, pid)
-      end
+      Result.new(
+        args: args,
+        status: {
+          code: status.exitstatus,
+          out: out,
+          err: err,
+          pid: status.pid
+        }
+      )
     end
   end
 end

data/lib/pdi/spoon/kitchen_error.rb

@@ -7,7 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-module PDI
+module Pdi
   class Spoon
     # This class subclasses Ruby's StandardError and provides a mapping to custom Kitchen
     # specific error codes to messages.

data/lib/pdi/spoon/options/arg.rb

@@ -7,7 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-module PDI
+module Pdi
   class Spoon
     class Options
       # This class can form Pentaho-specific command-line arguments.

data/lib/pdi/spoon/options/level.rb

@@ -7,7 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-module PDI
+module Pdi
   class Spoon
     class Options
       module Level

data/lib/pdi/spoon/options/param.rb

@@ -9,7 +9,7 @@
 
 require_relative 'arg'
 
-module PDI
+module Pdi
   class Spoon
     class Options
       # This class sub-classes Arg and knows how to form param key-value pair arguments.

data/lib/pdi/spoon/options.rb

@@ -12,7 +12,7 @@ require_relative 'options/level'
 require_relative 'options/param'
 require_relative 'pan_error'
 
-module PDI
+module Pdi
   class Spoon
     # This class serves as the input for executing a transformation or job through Pan or Kitchen.
     class Options

data/lib/pdi/spoon/pan_error.rb

@@ -7,7 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-module PDI
+module Pdi
   class Spoon
     # This class subclasses Ruby's StandardError and provides a mapping to custom Pan
     # specific error codes to messages.

data/lib/pdi/spoon/parser.rb

@@ -7,9 +7,9 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-module PDI
+module Pdi
   class Spoon
-    # This class knows how to parse the output of a Pan#version call.
+    # This class knows how to parse feedback from Pentaho and make sense of it.
     class Parser
       NEW_LINE = "\n"
 

data/lib/pdi/spoon/result.rb

@@ -7,7 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-module PDI
+module Pdi
   class Spoon
     # General return object for wrapping up a execution call result (execution) and
     # a usable result (value)

data/lib/pdi/spoon.rb

@@ -11,15 +11,16 @@ require_relative 'spoon/options'
 require_relative 'spoon/parser'
 require_relative 'spoon/result'
 
-module PDI
-  # This class is the main wrapper for PDI's pan and kitchen scripts.
+module Pdi
+  # This class is the main wrapper for Pdi's pan and kitchen scripts.
   class Spoon
     DEFAULT_KITCHEN = 'kitchen.sh'
     DEFAULT_PAN     = 'pan.sh'
 
-    attr_reader :dir, :kitchen, :pan
+    attr_reader :args, :dir, :kitchen, :pan
 
     def initialize(
+      args: [],
       dir:,
       kitchen: DEFAULT_KITCHEN,
       pan: DEFAULT_PAN
@@ -28,6 +29,7 @@ module PDI
       assert_required(:kitchen, kitchen)
       assert_required(:pan, pan)
 
+      @args           = Array(args)
       @dir            = dir.to_s
       @kitchen        = kitchen.to_s
       @pan            = pan.to_s
@@ -37,30 +39,28 @@ module PDI
       freeze
     end
 
+    # Returns a Spoon::Result instance when PDI returns error code 0 or else raises
+    # a KitchenError since Kitchen was used to run the version command.
     def version
-      args = [
-        kitchen_path,
-        Options::Arg.new(Options::Arg::Key::VERSION)
-      ]
+      final_args = [kitchen_path] + args + [Options::Arg.new(Options::Arg::Key::VERSION)]
 
-      result       = executor.run(args)
-      version_line = parser.version(result.out_and_err)
+      result       = executor.run(final_args)
+      version_line = parser.version(result.out)
+
+      raise(KitchenError, result) if result.code != 0
 
       Result.new(result, version_line)
     end
 
+    # Returns an Executor::Result instance when PDI returns error code 0 or else raises
+    # a PanError (transformation) or KitchenError (job).
     def run(options)
-      options = Options.make(options)
-
-      args = [
-        pan_path
-      ] + options.to_args
-
-      result = executor.run(args)
-
-      raise(options.error_constant, result) if result.code != 0
+      options    = Options.make(options)
+      final_args = [pan_path] + args + options.to_args
 
-      Result.new(result, result.code)
+      executor.run(final_args).tap do |result|
+        raise(options.error_constant, result) if result.code != 0
+      end
     end
 
     private

data/lib/pdi/version.rb

@@ -7,6 +7,6 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-module PDI
-  VERSION = '1.0.0-alpha'
+module Pdi
+  VERSION = '1.0.0-alpha.1'
 end

data/lib/pdi.rb

@@ -8,6 +8,7 @@
 #
 
 require 'acts_as_hashable'
+require 'forwardable'
 require 'open3'
 
 require_relative 'pdi/executor'

data/pdi.gemspec

@@ -4,11 +4,11 @@ require './lib/pdi/version'
 
 Gem::Specification.new do |s|
   s.name        = 'pdi'
-  s.version     = PDI::VERSION
-  s.summary     = 'Fill out summary'
+  s.version     = Pdi::VERSION
+  s.summary     = 'Ruby wrapper for invoking Pentaho Data Integration'
 
   s.description = <<-DESCRIPTION
-    Fill out description.
+    Pentaho Data Integration allows for the creation of ETL transformation and jobs.  This library allows those ETL tasks to be executed from Ruby.
   DESCRIPTION
 
   s.authors     = ['Matthew Ruggio']

data/spec/mocks/spoon/{return_0.sh → return_code.sh}

@@ -11,4 +11,4 @@ output(){
 output "output to stdout"
 error "output to sterr"
 
-exit 0
+exit $1

data/spec/pdi/spoon/error_spec.rb

@@ -9,19 +9,33 @@
 
 require 'spec_helper'
 
-describe PDI::Spoon::PanError do
+describe Pdi::Spoon::PanError do
   describe 'initialization' do
     [1, 2, 3, 7, 8, 9].each do |code|
       specify "code #{code} should have message" do
-        execution = PDI::Executor::Result.new('', code, '', 123)
-        expect(described_class.new(execution).message).not_to eq('Unknown')
+        result = Pdi::Executor::Result.new(
+          args: [],
+          status: {
+            code: code,
+            pid: 123
+          }
+        )
+
+        expect(described_class.new(result).message).not_to eq('Unknown')
       end
     end
 
     [-1, 0, 4, 5, 6, 10, 11].each do |code|
       specify "code #{code} should not have message" do
-        execution = PDI::Executor::Result.new('', code, '', 123)
-        expect(described_class.new(execution).message).to eq('Unknown')
+        result = Pdi::Executor::Result.new(
+          args: [],
+          status: {
+            code: code,
+            pid: 123
+          }
+        )
+
+        expect(described_class.new(result).message).to eq('Unknown')
       end
     end
   end

data/spec/pdi/spoon/options/arg_spec.rb

@@ -9,7 +9,7 @@
 
 require 'spec_helper'
 
-describe PDI::Spoon::Options::Arg do
+describe Pdi::Spoon::Options::Arg do
   let(:key)   { :param }
   let(:value) { 'v1' }
   let(:value_with_space) { 'v 1' }

data/spec/pdi/spoon/options/param_spec.rb

@@ -9,7 +9,7 @@
 
 require 'spec_helper'
 
-describe PDI::Spoon::Options::Param do
+describe Pdi::Spoon::Options::Param do
   let(:key)   { 'k1' }
   let(:value) { 'v1' }
   let(:value_with_space) { 'v 1' }

data/spec/pdi/spoon/options_spec.rb

@@ -9,7 +9,7 @@
 
 require 'spec_helper'
 
-describe PDI::Spoon::Options do
+describe Pdi::Spoon::Options do
   describe '#to_args' do
     let(:params) do
       {

data/spec/pdi/spoon_spec.rb

@@ -9,7 +9,8 @@
 
 require 'spec_helper'
 
-describe PDI::Spoon do
+describe Pdi::Spoon do
+  let(:script)    { 'return_code.sh' }
   let(:mocks_dir) { %w[spec mocks spoon] }
   let(:dir)       { File.join(*mocks_dir) }
 
@@ -25,9 +26,8 @@ describe PDI::Spoon do
 
       context 'when code is 0' do
         it 'returns correct stdout, stderr and code' do
-          script = 'return_0.sh'
-
           subject = described_class.new(
+            args: 0,
             dir: dir,
             kitchen: script,
             pan: script
@@ -35,18 +35,17 @@ describe PDI::Spoon do
 
           result = subject.run(options)
 
-          expect(result.execution.out_and_err).to eq("output to stdout\noutput to sterr\n")
-          expect(result.value).to                 eq(0)
-          expect(result.execution.code).to        eq(0)
+          expect(result.out).to  eq("output to stdout\n")
+          expect(result.err).to  eq("output to sterr\n")
+          expect(result.code).to eq(0)
         end
       end
 
       [1, 2, 3, 7, 8, 9].each do |code|
         context "when code is #{code}" do
           specify 'returns correct stdout, stderr and code' do
-            script = "return_#{code}.sh"
-
             subject = described_class.new(
+              args: code,
               dir: dir,
               kitchen: script,
               pan: script
@@ -73,9 +72,8 @@ describe PDI::Spoon do
 
       context 'when code is 0' do
         it 'returns correct stdout, stderr and code' do
-          script = 'return_0.sh'
-
           subject = described_class.new(
+            args: 0,
             dir: dir,
             kitchen: script,
             pan: script
@@ -83,18 +81,17 @@ describe PDI::Spoon do
 
           result = subject.run(options)
 
-          expect(result.execution.out_and_err).to eq("output to stdout\noutput to sterr\n")
-          expect(result.value).to                 eq(0)
-          expect(result.execution.code).to        eq(0)
+          expect(result.out).to  eq("output to stdout\n")
+          expect(result.err).to  eq("output to sterr\n")
+          expect(result.code).to eq(0)
         end
       end
 
       [1, 2, 7, 8, 9].each do |code|
         context "when code is #{code}" do
           specify 'returns correct stdout, stderr and code' do
-            script = "return_#{code}.sh"
-
             subject = described_class.new(
+              args: code,
               dir: dir,
               kitchen: script,
               pan: script
@@ -109,24 +106,40 @@ describe PDI::Spoon do
     end
 
     describe '#version' do
-      let(:script) { 'version.sh' }
-
       subject do
         described_class.new(
+          args: args,
           dir: dir,
           kitchen: script,
           pan: script
         )
       end
 
-      it 'returns parsed version line' do
-        result = subject.version
-        expected = [
-          '2020/01/30 13:31:04 - Pan - Kettle version 6.1.0.1-196,',
-          'build 1, build date : 2016-04-07 12.08.49'
-        ].join(' ')
+      context 'when code is 0' do
+        let(:script) { 'version.sh' }
+        let(:args)   { 0 }
+
+        it 'returns parsed version line' do
+          result = subject.version
+
+          expected = [
+            '2020/01/30 13:31:04 - Pan - Kettle version 6.1.0.1-196,',
+            'build 1, build date : 2016-04-07 12.08.49'
+          ].join(' ')
+
+          expect(result.value).to eq(expected)
+        end
+      end
+
+      context 'when code is not 0' do
+        let(:script) { 'return_code.sh' }
+        let(:args)   { 1 }
+
+        it 'raises KitchenError' do
+          expected = described_class::KitchenError
 
-        expect(result.value).to eq(expected)
+          expect { subject.version }.to raise_error(expected)
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdi
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha
+  version: 1.0.0.pre.alpha.1
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-03 00:00:00.000000000 Z
+date: 2020-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -122,7 +122,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
-description: "    Fill out description.\n"
+description: "    Pentaho Data Integration allows for the creation of ETL transformation
+  and jobs.  This library allows those ETL tasks to be executed from Ruby.\n"
 email:
 - mruggio@bluemarblepayroll.com
 executables:
@@ -146,6 +147,7 @@ files:
 - lib/pdi.rb
 - lib/pdi/executor.rb
 - lib/pdi/executor/result.rb
+- lib/pdi/executor/status.rb
 - lib/pdi/spoon.rb
 - lib/pdi/spoon/kitchen_error.rb
 - lib/pdi/spoon/options.rb
@@ -157,13 +159,7 @@ files:
 - lib/pdi/spoon/result.rb
 - lib/pdi/version.rb
 - pdi.gemspec
-- spec/mocks/spoon/return_0.sh
-- spec/mocks/spoon/return_1.sh
-- spec/mocks/spoon/return_2.sh
-- spec/mocks/spoon/return_3.sh
-- spec/mocks/spoon/return_7.sh
-- spec/mocks/spoon/return_8.sh
-- spec/mocks/spoon/return_9.sh
+- spec/mocks/spoon/return_code.sh
 - spec/mocks/spoon/version.sh
 - spec/pdi/spoon/error_spec.rb
 - spec/pdi/spoon/options/arg_spec.rb
@@ -193,15 +189,9 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Fill out summary
+summary: Ruby wrapper for invoking Pentaho Data Integration
 test_files:
-- spec/mocks/spoon/return_0.sh
-- spec/mocks/spoon/return_1.sh
-- spec/mocks/spoon/return_2.sh
-- spec/mocks/spoon/return_3.sh
-- spec/mocks/spoon/return_7.sh
-- spec/mocks/spoon/return_8.sh
-- spec/mocks/spoon/return_9.sh
+- spec/mocks/spoon/return_code.sh
 - spec/mocks/spoon/version.sh
 - spec/pdi/spoon/error_spec.rb
 - spec/pdi/spoon/options/arg_spec.rb

data/spec/mocks/spoon/return_1.sh

@@ -1,14 +0,0 @@
-#!/bin/bash
-
-error(){
-  echo "$1" >&2
-}
-
-output(){
-  echo "$1"
-}
-
-output "output to stdout"
-error "output to sterr"
-
-exit 1

data/spec/mocks/spoon/return_2.sh

@@ -1,14 +0,0 @@
-#!/bin/bash
-
-error(){
-  echo "$1" >&2
-}
-
-output(){
-  echo "$1"
-}
-
-output "output to stdout"
-error "output to sterr"
-
-exit 2

data/spec/mocks/spoon/return_3.sh

@@ -1,14 +0,0 @@
-#!/bin/bash
-
-error(){
-  echo "$1" >&2
-}
-
-output(){
-  echo "$1"
-}
-
-output "output to stdout"
-error "output to sterr"
-
-exit 3

data/spec/mocks/spoon/return_7.sh

@@ -1,14 +0,0 @@
-#!/bin/bash
-
-error(){
-  echo "$1" >&2
-}
-
-output(){
-  echo "$1"
-}
-
-output "output to stdout"
-error "output to sterr"
-
-exit 7

data/spec/mocks/spoon/return_8.sh

@@ -1,14 +0,0 @@
-#!/bin/bash
-
-error(){
-  echo "$1" >&2
-}
-
-output(){
-  echo "$1"
-}
-
-output "output to stdout"
-error "output to sterr"
-
-exit 8

data/spec/mocks/spoon/return_9.sh

@@ -1,14 +0,0 @@
-#!/bin/bash
-
-error(){
-  echo "$1" >&2
-}
-
-output(){
-  echo "$1"
-}
-
-output "output to stdout"
-error "output to sterr"
-
-exit 9