eco-rake 0.1.1

data/lib/eco-rake/shell/files.rb

@@ -0,0 +1,83 @@
+class EcoRake
+  module Shell
+    module Files
+      include Rake::DSL
+      DAY_SECONDS = (60 * 60 * 24)
+
+      # It creates directory `path` constructively.
+      # @note if any parent directory does not exist, it creates it as well.
+      def upsert_local_dir(path)
+        return if path.to_s.strip.empty?
+        return if File.directory?(path)
+        require 'fileutils'
+        puts "Creating directory '#{path}'"
+        FileUtils.mkdir_p(path)
+      end
+
+      # TODO: check delete status
+      def delete_file(*files, message: 'Deleting files:')
+        files = files.select {|file| File.exist?(file)}
+        return if files.empty?
+        puts message if message
+        files.each do |file|
+          File.delete(file)
+          puts " • #{file}" if message
+        end
+      end
+
+      def move_file(*files, folder:, message: 'Moving files:')
+        puts message if message
+        files.each do |file|
+          new_name = File.join(folder, File.basename(file))
+          File.name(file, new_name)
+          puts "  • #{File.basename(file)}" if message
+        end
+      end
+
+      # It identifies files in a folder by using different criteria.
+      # @return [Array<String>] files that match the criteria **sorted** by name ascendant (i.e. abc)
+      def folder_files(folder = ".", pattern = "*", regexp: nil, older_than: nil)
+        target = File.join(File.expand_path(folder), pattern)
+        Dir[target].tap do |dir_files|
+          dir_files.select! {|f| File.file?(f)}
+          dir_files.select! {|f| file_older_than?(f, days: older_than)} if older_than
+          dir_files.select! {|f| File.basename(f).match(regexp)}        if regexp.is_a?(Regexp)
+        end.sort
+      end
+
+      # @see #folder_files . Same but fixed to `*.csv` **pattern**
+      def csv_files(folder = ".", regexp: nil, older_than: nil)
+        folder_files(folder, "*.csv", regexp: regexp, older_than: older_than)
+      end
+
+      # @see #folder_files . Same but fixed to `*.csv.gpg` **pattern**
+      def gpg_files(folder = ".", regexp: nil, older_than: nil)
+        gpg = folder_files(folder, "*.gpg", regexp: regexp, older_than: older_than)
+        pgp = folder_files(folder, "*.pgp", regexp: regexp, older_than: older_than)
+        gpg.concat(pgp)
+      end
+
+      # Preserves the folder and the base name of `gpg_file` name
+      # and changes its extension to `csv`.
+      # @return [String]
+      def gpg_to_csv_filename(gpg_file)
+        return nil unless gpg_file
+        ext    = gpg_file.split('.')[1..-1].join('.')
+        base   = File.basename(gpg_file, ".#{ext}")
+        folder = File.dirname(gpg_file)
+        File.join(folder, "#{base}.csv")
+      end
+
+      private
+
+      def file_older_than?(file, days:)
+        File.mtime(file) < Time.now - days_to_seconds(days)
+      end
+
+      def days_to_seconds(days)
+        return nil unless days
+        days * DAY_SECONDS
+      end
+    end
+  end
+end

data/lib/eco-rake/shell/gpg.rb

@@ -0,0 +1,54 @@
+class EcoRake
+  module Shell
+    module Gpg
+      include EcoRake::Shell::Command
+      include EcoRake::Shell::Files
+
+      GPG_VERSION_REGEX = /^gpg.*?gnupg.*?(?<maj>\d+)\.(?<min>\d+)\./i.freeze
+
+      # @note
+      #   1. The ENV var `GPG_KEY` specifies the `passphrase` to be able to use the
+      #     private gpg key (suppsedly installed in the user's local `gpg keyring`).
+      #   2. Depending on the `gpg` version, the option to prevent the interactive passphrase to prompt
+      #     is different. This is the reason why we check what is the option for a `loopback`
+      # @param gpg_file [String] the file meant to be decrypted.
+      # @return [String] the command to decrypt `gpg_file`
+      def decrypt_command(gpg_file, gpg_key: ENV["GPG_KEY"], ignore_mdc_error: false)
+        csv_file = gpg_to_csv_filename(gpg_file)
+        no_error = ignore_mdc_error ? '--ignore-mdc-error' : nil
+        loopback = gpg_version_gte?(major: 2, minor: 1)? "--pinentry-mode=loopback" : "--batch --yes"
+        args     = [
+          no_error, loopback,
+          '--passphrase', double_quote(gpg_key),
+          '-o', double_quote(csv_file),
+          '-d', double_quote(gpg_file)
+        ]
+        string_cmd('gpg', *args)
+      end
+
+      private
+
+      # TODO: use a common end point from `Command`
+      def shell_gpg_version
+        `gpg --version`
+      end
+
+      # Checks if the host `gpg` version is **greater than or equal** (`gte`) to `major` and `minor`
+      # @note the versioning format is `MAJOR.MINOR.PATCH`
+      # @example if the host has this gpg version: `gpg (GnuPG) 2.1.10`. The following is to be expected:
+      #   1. `gpg_version_gte?(major: 1, minor: 10)` return `true`
+      #   2. `gpg_version_gte?(major: 3, minor: 0)` return `false`
+      #   3. `gpg_version_gte?(major: 2, minor: 0)` return `true`
+      #   4. `gpg_version_gte?(major: 2, minor: 1)` return `true`
+      #   5. `gpg_version_gte?(major: 2, minor: 3)` return `false`
+      # @return [Boolean]
+      def gpg_version_gte?(major:, minor:)
+        result = shell_gpg_version
+        return false unless match = result.match(GPG_VERSION_REGEX)
+        maj = match[:maj].to_i
+        min = match[:min].to_i
+        (maj >= major) && (min >= minor)
+      end
+    end
+  end
+end

data/lib/eco-rake/shell.rb

@@ -0,0 +1,18 @@
+require_relative 'shell/command'
+require_relative 'shell/files'
+require_relative 'shell/gpg'
+require_relative 'shell/eco_helpers'
+
+class EcoRake
+  module Shell
+    class << self
+      def included(base)
+        super(base)
+        base.send :include, Command
+        base.send :include, Files
+        base.send :include, Gpg
+        base.send :include, EcoHelpers
+      end
+    end
+  end
+end

data/lib/eco-rake/tasks.rb

@@ -0,0 +1,12 @@
+require_relative 'tasks/decrypt'
+require_relative 'tasks/feed'
+require_relative 'tasks/hris'
+require_relative 'tasks/sftp'
+
+# Offers a set of preconfigured tasks to inherit from
+# @note that these samples themselves do not get autoloaded,
+#   although their children do.
+class EcoRake
+  module Tasks
+  end
+end

data/lib/eco-rake/utils/mailer.rb

@@ -0,0 +1,91 @@
+class EcoRake
+  module Utils
+    # Mailer helper that uses `aws-sdk-ses` **gem** (`Aws::SES::Client`)
+    # Several ENV vars should be configured for it to work (i.e. in the `.env` file):
+    #   1. `MAILER_REGION`
+    #   2. `MAILER_KEY_ID`
+    #   3. `MAILER_ACCESS_KEY`
+    #   4. `MAILER_FROM`
+    class Mailer
+      # Sends an email
+      # @param to [String] destination email address
+      # @param subject [String] subject of the email
+      # @param body [String] `html` or plain text message
+      # @param from [String] the email address this is send **from**
+      def mail(to:, subject:, body:, from: nil, cc: nil, bcc: nil)
+        unless configured?
+          puts "Mailer: You are missing configuration parameters. Review your .env file"
+          return false
+        end
+        ses.send_email(
+          destination: fetch_to(to: to, cc: cc, bcc: bcc),
+          source:      fetch_from(from),
+          message:     {
+            subject: {
+              charset: "UTF-8",
+              data:    subject
+            },
+            body:    {
+              # NOTEL: `html:` will let you send html instead
+              # you can use both at once if you like
+              text: {
+                charset: "UTF-8",
+                data:    body
+              }
+            }
+          }
+        ).tap do |response|
+          puts "Sent email to #{to} (MessageId: #{response.message_id})"
+        end
+      end
+
+      # @return [Boolean] whether or not the mailer is configured for usage.
+      def configured?
+        fetch_access_key_id && fetch_secret_access_key && fetch_region
+      end
+
+      private
+
+      def ses
+        require 'aws-sdk-ses'
+        begin
+          @ses ||= Aws::SES::Client.new(
+            access_key_id:     fetch_access_key_id,
+            secret_access_key: fetch_secret_access_key,
+            region:            fetch_region
+          )
+        rescue StandardError => e
+          puts "Trying to send an email with wrong email configuration: #{e}"
+        end
+        @ses
+      end
+
+      def fetch_to(to: nil, cc: nil, bcc: nil)
+        {
+          to_addresses: [to].flatten.compact.uniq
+        }.tap do |dest|
+          cc  = [cc].flatten.compact.uniq
+          bcc = [bcc].flatten.compact.uniq
+          dest.merge!(cc_addresses: cc)   unless cc.empty?
+          dest.merge!(bcc_addresses: bcc) unless bcc.empty?
+        end
+      end
+
+      def fetch_from(value = nil)
+        value || ENV['MAILER_FROM']
+      end
+
+      def fetch_access_key_id
+        ENV['MAILER_KEY_ID']
+      end
+
+      def fetch_secret_access_key
+        ENV['MAILER_ACCESS_KEY']
+      end
+
+      def fetch_region
+        ENV['MAILER_REGION']
+      end
+    end
+  end
+end

data/lib/eco-rake/utils/mailing.rb

@@ -0,0 +1,19 @@
+class EcoRake
+  module Utils
+    module Mailing
+      # @return [EcoRake::Mailer]
+      def mailer
+        @mailer ||= EcoRake::Utils::Mailer.new
+      end
+
+      # Helper to notify that there are no files to be processed
+      def email_missing_files(enviro:, to:)
+        mailer.mail(**{
+          to:      to,
+          subject: "#{enviro.upcase} (No files to be processed)",
+          body:    'No files found to be processed. Aborting...'
+        })
+      end
+    end
+  end
+end

data/lib/eco-rake/utils/timing.rb

@@ -0,0 +1,9 @@
+class EcoRake
+  module Utils
+    module Timing
+      def today?(date)
+        date && date.strftime("%Y/%m/%d") == Time.now.strftime("%Y/%m/%d")
+      end
+    end
+  end
+end

data/lib/eco-rake/utils.rb

@@ -0,0 +1,19 @@
+require_relative 'utils/mailer'
+require_relative 'utils/mailing'
+require_relative 'utils/timing'
+
+class EcoRake
+  module Utils
+    class << self
+      def included(base)
+        super(base)
+        base.extend ClassMethods
+        base.send :include, Mailing
+        base.send :include, Timing
+      end
+    end
+
+    module ClassMethods
+    end
+  end
+end

data/lib/eco-rake/version.rb

@@ -0,0 +1,5 @@
+require 'rake-commander'
+
+class EcoRake < RakeCommander
+  VERSION = '0.1.1'.freeze
+end

data/lib/eco-rake.rb

@@ -0,0 +1,16 @@
+require 'rake-commander'
+require 'dotenv'
+require 'dotenv/load'
+
+class EcoRake < RakeCommander
+  autoload_namespace_ignore "EcoRake::Tasks"
+
+  require_relative 'eco-rake/version'
+  require_relative 'eco-rake/base'
+  include EcoRake::Base
+end
+
+RakeCommander::Patcher.debug = ENV['COMMANDER_DEBUG'] == "true"
+
+require_relative 'eco-rake/lib'
+require_relative 'eco-rake/custom'

metadata

@@ -0,0 +1,271 @@
+--- !ruby/object:Gem::Specification
+name: eco-rake
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Oscar Segura Samper
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.34
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.34
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake-commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description:
+email:
+- oscar@ecoportal.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- eco-rake.gemspec
+- lib/eco-rake.rb
+- lib/eco-rake/base.rb
+- lib/eco-rake/base/method_helpers.rb
+- lib/eco-rake/base/symbol_resolver.rb
+- lib/eco-rake/custom.rb
+- lib/eco-rake/default.rb
+- lib/eco-rake/default/const.rb
+- lib/eco-rake/lib.rb
+- lib/eco-rake/lib/base_task.rb
+- lib/eco-rake/lib/concern.rb
+- lib/eco-rake/lib/concern/base.rb
+- lib/eco-rake/lib/concern/enviro.rb
+- lib/eco-rake/lib/concern/local_folder.rb
+- lib/eco-rake/lib/concern/person_schema.rb
+- lib/eco-rake/lib/export.rb
+- lib/eco-rake/lib/export/payload.rb
+- lib/eco-rake/lib/files.rb
+- lib/eco-rake/lib/files/decrypt.rb
+- lib/eco-rake/lib/files/purge.rb
+- lib/eco-rake/lib/files/sftp.rb
+- lib/eco-rake/lib/notify.rb
+- lib/eco-rake/lib/notify/mailer.rb
+- lib/eco-rake/lib/options.rb
+- lib/eco-rake/lib/people.rb
+- lib/eco-rake/lib/people/base_task.rb
+- lib/eco-rake/lib/people/sync_launch.rb
+- lib/eco-rake/lib/people/sync_options.rb
+- lib/eco-rake/lib/people/sync_process.rb
+- lib/eco-rake/lib/people/sync_rely.rb
+- lib/eco-rake/lib/task.rb
+- lib/eco-rake/lib/task/runner_launch.rb
+- lib/eco-rake/lib/task/runner_options.rb
+- lib/eco-rake/lib/task/runner_rely.rb
+- lib/eco-rake/option.rb
+- lib/eco-rake/option/default_lookup.rb
+- lib/eco-rake/option/mirror.rb
+- lib/eco-rake/option/parented.rb
+- lib/eco-rake/options.rb
+- lib/eco-rake/options/default_lookup.rb
+- lib/eco-rake/options/forwarding.rb
+- lib/eco-rake/options/forwarding/proxy.rb
+- lib/eco-rake/options/forwarding/rule.rb
+- lib/eco-rake/options/library.rb
+- lib/eco-rake/options/parental.rb
+- lib/eco-rake/options/set.rb
+- lib/eco-rake/rake_task.rb
+- lib/eco-rake/shell.rb
+- lib/eco-rake/shell/command.rb
+- lib/eco-rake/shell/eco_helpers.rb
+- lib/eco-rake/shell/files.rb
+- lib/eco-rake/shell/gpg.rb
+- lib/eco-rake/tasks.rb
+- lib/eco-rake/utils.rb
+- lib/eco-rake/utils/mailer.rb
+- lib/eco-rake/utils/mailing.rb
+- lib/eco-rake/utils/timing.rb
+- lib/eco-rake/version.rb
+homepage: https://www.ecoportal.com
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: A set of helpers to build re-usable `rake` integration helpers.
+test_files: []