eco-rake 0.2.16 → 0.2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6adc55db4ba9cc01ef0f3bd19630c8028431e12cd2846a8242d885adcea349a9
-  data.tar.gz: ee6222a4f3018f6fc0d945a7c7092dccea23342501e345ba10a8417333ade30b
+  metadata.gz: 7876dd36735ea99fcb006628a2f8fe2c49c05115befe40f64ac82337a9851b29
+  data.tar.gz: 17042f197a6535f2f33f2ebc0ff3de57d0628c4eef561340e443c1a43f7d5c3d
 SHA512:
-  metadata.gz: f09228e9b94773ba18a528116f3094f641b832da371357fff4ea72f70900bef36ca0407e6604009d216a91ad45c1add2731fb7eea499f1561f5e087156fda298
-  data.tar.gz: bf02711a0c9939086153ad9206cd87298335b8e1a5b0fa11042855e81039de8fbce53da8e3db8b8fffeb3b88b7e5867c6caad1afb6e15961a9638fab86655bf4
+  metadata.gz: f3932c8e52dc30e19b2f12292fe6349974a33136622a6ba4165e2e8c2096b9bffbabca76f8c50fa1373101a9180c179e58d8866cc82559b2340a373620c66251
+  data.tar.gz: 1afc961abec0938ea8d4007cb644d7adb8ec21b01f166769e75ed7458f50441777763cb49f1c299ab31a23673770aedb814120d8564adcc3af98570aca5e4ffe

data/.gitignore

@@ -26,3 +26,4 @@ Gemfile.lock
 scratch.rb
 
 /.byebug_history
+.solargraph.yml

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.2.17] - 2025-03-xx
+## [0.2.18] - 2025-03-xx
 
 ### Added
 
@@ -10,6 +10,21 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [0.2.18] - 2025-03-22
+
+### Changed
+
+- Command invocation cases on `Export::Payload` related tasks.
+
+## [0.2.17] - 2025-03-22
+
+### Added
+
+- `space` to mailing.
+- Export `payload` notify
+  - On error
+  - On success
+
 ## [0.2.16] - 2025-03-11
 
 ### Fixed

data/lib/eco-rake/lib/export/payload.rb

@@ -1,39 +1,58 @@
 # Use case for special integrations. It requires some use cases to be present
-#  1. `-export-select-options`
-#  2. `-export-registers`
-#  3. `-export-pack`
-#  4. `-export-sftp-push`
+#  1. `-extract-select-options`
+#  2. `-extract-registers`
+#  3. `-extract-pack`
+#  4. `-extract-sftp-push`
 require 'optparse/time'
 class EcoRake
   module Lib
     module Export
       class Payload < EcoRake::Lib::BaseTask
-        INCLUDED_OPTIONS = %i[csv simulate].freeze
+        INCLUDED_OPTIONS = %i[csv simulate no_email].freeze
         FORWARD_RULES    = {
-          enviro:   ->(enviro) { "-#{enviro}" },
-          space:    ->(space) { "-space #{space}" },
+          enviro:   ->(enviro) { "-#{enviro}"      },
+          space:    ->(space)  { "-space #{space}" },
           simulate: '-simulate',
+          no_email: '-no-email',
           csv:      '-csv',
           full:     ->(full) { full ? nil : '-delta' },
           asat:     ->(asat) { "-asatdate #{asat}" }
         }.freeze
 
+        attr_const :mail_to
+
         options_with_defaults true
         option '-s', '--simulate', TrueClass, 'Do a dry-run (with no changes)'
-        option '-e', '--enviro ENVIRO', String, desc: 'Target environment to run against (i.e. org, live)', required: true # , default_lookup: :default_enviro
-        option '-w', '--space SPACE', String, desc: 'Target space of the envionment (i.e. uat)'
-        option '-f', '--[no-]full', TrueClass, default: false, desc: 'If the PAYLOAD file is a full file (false: means delta)'
-        option '-c', '--csv', TrueClass, default: true, desc: 'Generate files in csv format?'
-        option '-a', '--asat [DATE]', Time, default: Time.now.iso8601, desc: 'Specifies the date when the export was done (default: now).' do |value|
+
+        str_desc = 'Target environment to run against (i.e. org, live)'
+        option '-e', '--enviro ENVIRO', String, desc: str_desc, required: true # , default_lookup: :default_enviro
+
+        str_desc = 'Target space of the envionment (i.e. uat)'
+        option '-w', '--space SPACE', String, desc: str_desc
+
+        str_desc = 'If the PAYLOAD file is a full file (false: means delta)'
+        option '-f', '--[no-]full', TrueClass, default: false, desc: str_desc
+
+        str_desc = 'Generate files in csv format?'
+        option '-c', '--csv', TrueClass, default: true, desc: str_desc
+
+        str_desc = 'Specifies the date when the export was done (default: now).'
+        option '-a', '--asat [DATE]', Time, default: Time.now.iso8601, desc: str_desc do |value|
           value&.iso8601
         end
 
+        option '-m', '--no-email', FalseClass, desc: 'Do not notify'
+
         option_forwarding(**FORWARD_RULES)
 
         def task(*_args)
-          sh_chain(commands) do |ok, _res|
-            exit 1 unless ok
+          sh_chain(commands) do |ok, res|
+            next if ok
+
+            error_notify!(res)
           end
+
+          success_notify
         end
 
         private
@@ -48,19 +67,19 @@ class EcoRake
         end
 
         def export_select_options
-          forward_command('-export-select-options')
+          forward_command('-extract-select-options')
         end
 
         def export_registers
-          forward_command('-export-registers')
+          forward_command('-extract-registers')
         end
 
         def export_pack
-          forward_command('-export-pack', :full, :asat)
+          forward_command('-extract-pack', :full, :asat)
         end
 
         def export_sftp_push
-          base_command('-export-sftp-push')
+          forward_command('-extract-sftp-push')
         end
 
         def forward_command(use, *opts)
@@ -81,6 +100,39 @@ class EcoRake
             use
           )
         end
+
+        def success_notify
+          return if options[:simulate]
+          return if options[:no_email]
+          return unless (inbox = mail_to)
+
+          email(
+            subject: "Payload pushed",
+            to:      inbox,
+            body:    'The data extract has been correctly pushed.',
+            enviro:  options[:enviro],
+            space:   options[:space]
+          )
+        end
+
+        def error_notify!(res)
+          msg = res.to_s
+          puts msg
+
+          exit 1 if options[:simulate]
+          exit 1 if options[:no_email]
+          exit 1 unless (inbox = mail_to)
+
+          email(
+            subject: "Error exporting payload",
+            to:      inbox,
+            body:    'Could not push latest extract.',
+            enviro:  options[:enviro],
+            space:   options[:space]
+          )
+
+          exit 1
+        end
       end
     end
   end

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

@@ -17,7 +17,7 @@ class EcoRake
           target_files.each do |file|
             delete_file(gpg_to_csv_filename(file))
 
-            stat   = sh_continue(
+            stat = sh_continue(
               decrypt_command(file, ignore_mdc_error: ignore_mdc_error)
             )
 

data/lib/eco-rake/lib/people/sync_launch.rb

@@ -63,7 +63,12 @@ class EcoRake
           exit 1 if options[:no_email]
           exit 1 unless (inbox = mail_to)
 
-          email_missing_files(enviro: target_enviro, to: inbox)
+          email_missing_files(
+            to:     inbox,
+            enviro: target_enviro,
+            space:  options[:space]
+          )
+
           exit 1
         end
 
@@ -156,7 +161,9 @@ class EcoRake
             deleted << file
           end
 
-          puts "Deleted these files:\n  • #{deleted_files.join("\n  • ")}" unless deleted_files.empty?
+          return if deleted_files.empty?
+
+          puts "Deleted these files:\n  • #{deleted_files.join("\n  • ")}"
         end
       end
     end

data/lib/eco-rake/lib/people/sync_process.rb

@@ -66,11 +66,19 @@ class EcoRake
         def failed_decryption_notify
           msg = 'File decryption failed'
           puts msg
+
           exit 1 if options[:simulate]
           exit 1 if options[:no_email]
           exit 1 unless (inbox = mail_to)
 
-          email(enviro: target_enviro, to: inbox, subject: msg, body: msg)
+          email(
+            to:      inbox,
+            subject: msg,
+            body:    msg,
+            enviro:  target_enviro,
+            space:   options[:space]
+          )
+
           exit 1
         end
       end

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

@@ -65,9 +65,9 @@ class EcoRake
       # and changes its extension to `csv`.
       # @return [String]
       def gpg_to_csv_filename(gpg_file)
-        return nil unless gpg_file
+        return unless gpg_file
 
-        ext    = gpg_file.split('.')[1..-1].join('.')
+        ext    = gpg_file.split('.')[1..].join('.')
         base   = File.basename(gpg_file, ".#{ext}")
         folder = File.dirname(gpg_file)
         File.join(folder, "#{base}.csv")

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

@@ -13,16 +13,20 @@ class EcoRake
       #     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)
+      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"
+
+        loopback = '--batch --yes'
+        loopback = '--pinentry-mode=loopback' if gpg_version_gte?(major: 2, minor: 1)
+
         args     = [
           no_error, loopback,
           '--passphrase', double_quote(gpg_key),
           '-o', double_quote(csv_file),
           '-d', double_quote(gpg_file)
         ]
+
         string_cmd('gpg', *args)
       end
 
@@ -37,10 +41,10 @@ class EcoRake
       # @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`
+      #   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

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

@@ -6,9 +6,15 @@ class EcoRake
         @mailer ||= EcoRake::Utils::Mailer.new
       end
 
-      def email(subject:, body:, to:, enviro: nil)
+      def email(subject:, body:, to:, enviro: nil, space: nil)
         has_enviro = enviro && subject&.downcase&.include?(enviro.downcase)
-        subject    = "#{enviro.upcase} - #{subject}" if enviro && !has_enviro
+
+        if enviro && !has_enviro
+          env_str  = enviro.upcase
+          env_str << " (space: #{space})" if space
+          subject  = "#{env_str} - #{subject}"
+        end
+
         mailer.mail(
           to:      to,
           subject: subject,
@@ -17,11 +23,13 @@ class EcoRake
       end
 
       # Helper to notify that there are no files to be processed
-      def email_missing_files(enviro:, to:)
+      def email_missing_files(enviro:, to:, space: nil)
         email(
           to:      to,
-          subject: "#{enviro.upcase} (No files to be processed)",
-          body:    'No files found to be processed. Aborting...'
+          subject: "No files to be processed",
+          body:    'No files found to be processed. Aborting...',
+          enviro:  enviro,
+          space:   space
         )
       end
     end

data/lib/eco-rake/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-rake
 version: !ruby/object:Gem::Version
-  version: 0.2.16
+  version: 0.2.18
 platform: ruby
 authors:
 - Oscar Segura Samper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake