pdi 1.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7934ad85a3ff2d1c40beb617ca4d1d0ad24aaa3b937bb09409836ef12b245f06
+  data.tar.gz: d4a096374986562781a18905a8e9ea64039750f22e82e3b67d386143c31b2915
+SHA512:
+  metadata.gz: c3f8ecf38e493e95100bfba8e92da5c344e629b89268c484ddb03834f32e8627e150e54705ca034176c63255c29db87c2b87b2ded8a5daf9033b161e57bdef5e
+  data.tar.gz: 0b299a6e8466c26de5c9dfada312beaae2a171c913b35dcba06ad2d34fb7a5cb9a82f1d48bd972bc08912acffed6f4e4941ad2665ab5a80fe6add18bacb71d00

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+Gemfile.lock
+/pkg

data/.rubocop.yml

@@ -0,0 +1,25 @@
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - pdi.gemspec
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - let
+    - it
+    - describe
+    - context
+    - specify
+    - define
+
+Metrics/MethodLength:
+  Max: 25
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Max: 16
+
+Metrics/ClassLength:
+  Max: 125

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -0,0 +1,25 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=b2689967e1b2c3b5781da37cfc0eb4e0058178a78bba54294bf0c2a7c9e5cb63
+language: ruby
+rvm:
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.5
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec --format documentation
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+addons:
+  # https://docs.travis-ci.com/user/uploading-artifacts/
+  artifacts:
+    paths:
+      - Gemfile.lock

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at oss@bluemarblepayroll.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Blue Marble Payroll, LLC
+
+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,133 @@
+# PDI
+
+---
+
+[![Gem Version](https://badge.fury.io/rb/pdi.svg)](https://badge.fury.io/rb/pdi) [![Build Status](https://travis-ci.org/bluemarblepayroll/pdi.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/pdi) [![Maintainability](https://api.codeclimate.com/v1/badges/955e491a34465360bf64/maintainability)](https://codeclimate.com/github/bluemarblepayroll/pdi/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/955e491a34465360bf64/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/pdi/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+*Note: This is not officially supported by Hitachi Vantara.*
+
+This library provides a Ruby wrapper around [Pentaho Data Integration](https://www.hitachivantara.com/en-us/products/data-management-analytics/pentaho-platform/pentaho-data-integration.html) that allows you to execute tranformations and jobs via command line.
+
+## Installation
+
+To install through Rubygems:
+
+````bash
+gem install pdi
+````
+
+You can also add this to your Gemfile:
+
+````bash
+bundle add pdi
+````
+
+## Compatibility
+
+This library was tested against:
+
+* Kettle version 6.1.0.1-196
+* MacOS and Linux
+
+Pull Requests are welcome for:
+
+* Windows support
+* Upgraded Kettle versions (while maintaining backwards compatibility)
+
+## Examples
+
+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.
+
+```ruby
+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.
+
+### Executing a Job/Transformation
+
+```ruby
+options = {
+  level: PDI::Spoon::Level::DETAILED,
+  name: 'update_address',
+  repository: 'transformations/demographics',
+  params: {
+    file: 'addresses.csv'
+  },
+  type: :transformation
+}
+
+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.
+
+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.
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check pdi.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/pdi.git)
+4. Navigate to the root folder (cd pdi)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite and code-coverage tool, run:
+
+````bash
+bundle exec rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````bash
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````bash
+bundle exec rubocop
+````
+
+or run all three in one command:
+
+````bash
+bundle exec rake
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into master
+2. Update `lib/pdi/version.rb` using [semantic versioning](https://semver.org/)
+3. Install dependencies: `bundle`
+4. Update `CHANGELOG.md` with release notes
+5. Commit & push master to remote and ensure CI builds master successfully
+6. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Code of Conduct
+
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bluemarblepayroll/pdi/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is MIT Licensed.

data/Rakefile

@@ -0,0 +1,17 @@
+# 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.
+#
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-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.
+#
+
+require 'bundler/setup'
+require 'pdi'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/lib/pdi.rb

@@ -0,0 +1,14 @@
+# 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.
+#
+
+require 'acts_as_hashable'
+require 'open3'
+
+require_relative 'pdi/executor'
+require_relative 'pdi/spoon'

data/lib/pdi/executor.rb

@@ -0,0 +1,30 @@
+# 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.
+#
+
+require_relative 'executor/result'
+
+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)
+      cmd = args.flatten.join(SPACE)
+
+      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
+    end
+  end
+end

data/lib/pdi/executor/result.rb

@@ -0,0 +1,29 @@
+# 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 an execution call result.
+    class Result
+      attr_reader :cmd,
+                  :code,
+                  :out_and_err,
+                  :pid
+
+      def initialize(cmd, code, out_and_err, pid)
+        @cmd         = cmd
+        @code        = code
+        @out_and_err = out_and_err
+        @pid         = pid
+
+        freeze
+      end
+    end
+  end
+end

data/lib/pdi/spoon.rb

@@ -0,0 +1,82 @@
+# 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.
+#
+
+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.
+  class Spoon
+    DEFAULT_KITCHEN = 'kitchen.sh'
+    DEFAULT_PAN     = 'pan.sh'
+
+    attr_reader :dir, :kitchen, :pan
+
+    def initialize(
+      dir:,
+      kitchen: DEFAULT_KITCHEN,
+      pan: DEFAULT_PAN
+    )
+      assert_required(:dir, dir)
+      assert_required(:kitchen, kitchen)
+      assert_required(:pan, pan)
+
+      @dir            = dir.to_s
+      @kitchen        = kitchen.to_s
+      @pan            = pan.to_s
+      @executor       = Executor.new
+      @parser         = Parser.new
+
+      freeze
+    end
+
+    def version
+      args = [
+        kitchen_path,
+        Options::Arg.new(Options::Arg::Key::VERSION)
+      ]
+
+      result       = executor.run(args)
+      version_line = parser.version(result.out_and_err)
+
+      Result.new(result, version_line)
+    end
+
+    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
+
+      Result.new(result, result.code)
+    end
+
+    private
+
+    attr_reader :executor, :parser
+
+    def kitchen_path
+      File.join(dir, kitchen)
+    end
+
+    def pan_path
+      File.join(dir, pan)
+    end
+
+    def assert_required(name, value)
+      raise ArgumentError, "#{name} is required" if value.to_s.empty?
+    end
+  end
+end