pal_tool 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5f67faa3445eeb19902f29060727941545cd135f8ba3f63a743880c5ab4bbe8
+  data.tar.gz: b8637e50cea0501daf9bb845341e8f1b2cc3e84e2e45cef8fec1a1a326ce4423
+SHA512:
+  metadata.gz: 8c1dea3e1bacb580495000ed681d1d4e7a1f080dd6f5d4734bfeadba7c7bd6229b7a11fc0a1401b03a5703321a016f1a370c62e507911b5f48715339899ed383
+  data.tar.gz: 3c84a52fd6e66aa093d36b6fa8b5799468ef8a1292b9bb50dfe51c057b2ba57bf0ae4c303e8bb33b9b56c0a6b7107f2f5268e7b18547674579aad162ee91b2c1

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,132 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength:
+  Max: 20
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# Most readable form.
+Style/OptionHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/PreferredHashMethods:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: "inject"
+
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense.
+Style/RaiseArgs:
+  Enabled: false
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/SuppressedException:
+  Enabled: false
+
+#Layout/SpaceInsideBlockBraces:
+#  # The space here provides no real gain in readability while consuming
+#  # horizontal space that could be used for a better parameter name.
+#  # Also {| differentiates better from a hash than { | does.
+#  SpaceBeforeBlockParameters: false
+
+# No trailing space differentiates better from the block:
+# foo} means hash, foo } means block.
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Check with yard instead.
+Style/Documentation:
+  Enabled: false
+
+# There are valid cases, for example debugging Cucumber steps,
+# also they'll fail CI anyway
+Lint/Debugger:
+  Enabled: false
+
+# Style preference
+Style/MethodDefParentheses:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at me@williamthom.as. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:3.0.2
+RUN apt-get update && apt-get install -y \
+  build-essential
+
+RUN mkdir /app
+WORKDIR /app
+COPY . .
+RUN gem install bundler && bundle install --jobs 20 --retry 5
+RUN rake install
+CMD ["bash"]

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pal.gemspec
+gemspec
+
+gem 'jsonpath', '~> 1.1', '>= 1.1.2'
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    pal_tool (0.2.1)
+      rcsv
+      terminal-table
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    jsonpath (1.1.2)
+      multi_json
+    multi_json (1.15.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rcsv (0.3.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  jsonpath (~> 1.1, >= 1.1.2)
+  pal_tool!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  simplecov
+
+BUNDLED WITH
+   2.2.30

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 william
+
+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,124 @@
+# Pal
+
+![run tests](https://github.com/williamthom-as/pal/actions/workflows/rspec.yml/badge.svg)
+
+Pal is a tool for automating simple tabular data analysis. It provides just enough features to be useful.
+It has been primarily designed to assist with cloud billing reports, but can work generically across any tabular CSV file.
+- **Reporting as Code**: Describe simple routines to **extract**, **filter** and **manipulate** data from spreadsheets.
+  - Quickly filter, manipulate and transform your spreadsheet into consumable, understandable insight using one or more provided export functions (including CSV, chart, table, interactive report). 
+  - Export filtered data into common data formats for further analysis or visualisation in a different tool.
+  - Run, version and share report template definitions with others.
+- **Plugins**: Extend Pal hooks with your own functionality. Read more about it [here](plugins/PLUGINS.md).
+
+## Use Cases
+
+Common use cases are:
+- Analyse data using a "write once, run any time" templating approach [see examples below].
+- Analysing cloud spend can be a complex task, use Pal to help start the conversation or drill deep into specifics.
+- Automate the break down of large and unwieldy provider spreadsheets into more digestable and "Excel friendly" files.
+
+## Usage
+
+Two things are needed to run Pal, the *spreadsheet* and a *template* file. Optionally, you can provide an output directory, otherwise it will use ``/tmp/pal``.
+
+Provide these to Pal as arguments as follows: 
+
+    $ pal -t /file/path/to/template.json -s /file/path/to/billing_file.csv -o /my/output/folder
+
+## Example
+
+Below shows the template and export from a simple request. 
+
+It shows grouping all records from an AWS Cost and Usage Report by product and usage type, summing blended cost fields.
+
+#### Template
+```json
+{
+  ...
+  "filters":  {
+    "condition": "AND",
+    "rules": [{
+        "field": "lineItem/BlendedCost",
+        "type": "number",
+        "operator": "greater",
+        "value": 0
+      }
+    ]
+  },
+  "exporter" : {
+    "types" : [{
+      "name" : "table",
+      ...
+    }],
+    "properties" : [
+      "lineItem/ProductCode",
+      "lineItem/UsageType",
+      "lineItem/BlendedCost"
+    ],
+    "actions" : {
+      "group_by" : ["lineItem/ProductCode", "lineItem/UsageType"],
+      "sort_by" : "sum_lineItem/BlendedCost",
+      "projection" : {
+        "type" : "sum",
+        "property" : "lineItem/BlendedCost"
+      }
+    }
+  }
+}
+```
+*Find full template [here](templates/aws/global_resource_and_usage_type_costs.json)*.
+
+#### Exported
+```bash
++------------------------------------------------------------------------------------+
+|                     AWS CUR Product/Usage Type Combined Costs                      |
++----------------------+----------------------------------+--------------------------+
+| lineItem/ProductCode | lineItem/UsageType               | sum_lineItem/BlendedCost |
++----------------------+----------------------------------+--------------------------+
+| AmazonEC2            | APS2-EBS:VolumeUsage.gp2         | 48.80                    |
+| AmazonRDS            | APS2-RDS:ChargedBackupUsage      | 8.12                     |
+| AmazonEC2            | APS2-ElasticIP:IdleAddress       | 6.71                     |
+| AmazonEC2            | APS2-EBS:SnapshotUsage           | 5.64                     |
+...
+```
+
+Understand more about how templates work by clicking [here](templates/DOCUMENTATION.md).
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install pal
+
+### Getting started *quickly*
+To quickly spin up a development environment, please use the Dockerfile provided. Run:
+
+    $ docker build -t pal .
+    $ docker run -it --rm pal bash
+
+Please do not forget to mount any volumes which may have templates that you wish to use. Default templates are available too, found under `/app/templates`.
+
+Once set up and connected to your container, run:
+
+    $ pal -t /file/path/to/template.json -s /file/path/to/billing_file.csv -o /my/output/folder
+
+## Upcoming changes
+1. Provide the ability to format exports
+  
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/williamthom-as/pal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/pal/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pal project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pal/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pal"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/pal

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+require "pal"
+
+include Pal::Configuration
+include Pal::Log
+
+request_config = Config.new
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: pal_cli [options]"
+
+  opts.on("-t", "--template_file=template_file", "Template definition file") do |t|
+    request_config.template_file_loc = t
+  end
+
+  opts.on("-s", "--source_file=source_file", "Source file") do |s|
+    request_config.source_file_loc = s
+  end
+
+  opts.on("-o", "--output_dir=output_dir", "Output directory") do |o|
+    request_config.output_dir = o
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+begin
+  request_config.validate
+rescue Pal::ValidationError
+  log_error("The request provided was invalid, please fix the validation errors and try again.")
+  return
+end
+
+log_info "Config loaded successfully"
+main = Pal::Main.new(request_config)
+
+log_info "Setting up runbooks to be processed ..."
+main.setup
+
+log_info "... set up complete. Beginning process"
+main.process

data/lib/pal/common/local_file_utils.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "pal"
+require "fileutils"
+
+module Pal
+  module Common
+    class LocalFileUtils
+      def self.with_file(path, extension, &block)
+        dir = File.dirname(path)
+
+        FileUtils.mkdir_p(dir) unless File.directory?(dir)
+
+        path << ".#{extension}"
+        File.open(path, "w", &block)
+      end
+
+      def self.clean_dir(path)
+        dir = File.dirname(path)
+
+        FileUtils.rm_rf(dir) if File.directory?(dir)
+      end
+
+      def self.remove_file(path_to_file)
+        File.delete(path_to_file) if File.exist?(path_to_file)
+      end
+
+      def self.read_file(file_location)
+        result = file_location.start_with?("/") ? file_location : File.join(File.dirname(__FILE__), file_location)
+
+        raise "No file found at [#{result}]" unless File.exist? result
+
+        File.read(result)
+      end
+    end
+  end
+end

data/lib/pal/common/object_helpers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "pal"
+
+module Pal
+  # Object helper module
+  module ObjectHelpers
+    def attributes=(hash)
+      hash.each do |key, value|
+        send("#{key}=", value)
+      rescue NoMethodError
+        Pal.logger.warn("Error deserializing object: No property for #{key}")
+      end
+    end
+
+    def from_json(json)
+      return from_hash(json) if json.is_a?(Hash) # Just a guard in case serialisation is done
+
+      from_hash(JSON.parse(json))
+    end
+
+    def from_hash(hash)
+      self.attributes = hash
+      self
+    end
+  end
+end