eco-rake 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62670eef7e735906c2b7c85ce0ec355809e56388c81c62b7829c0615c5ac02a6
-  data.tar.gz: b8061d3eec87948c8320d9320c09ed1a97426402893b6320e114310d2600dcba
+  metadata.gz: 391b705005f0caede947bd5260f5f6f04e794bf1af974509b87cf7e8a751c58c
+  data.tar.gz: 015ea6c334d09e3fd7c464b04a8e41e2089a9417f239f82ba814f992ea7f6ff5
 SHA512:
-  metadata.gz: 73653313c3f6ca4be1ea38c22b77496921b7fb99d171cc876d2667cf38b0d41b99958df47ad760aeff4809613d881922ef4dc3145e152c35ef623363aaba21fe
-  data.tar.gz: c8365601b42e4ac8c36f696d1c657d2455355d92d9376cc32d16f7cb2e24e4ef0ac56fbfd7b0b2eeb480f266ad6090f359dc3ad36f487f6b077ea272ba3ca4ee
+  metadata.gz: 1355859370ee7cc87bb1f7ae87da8749bd7178afd745dc4a58b3020ed525497d1d8a6c533ce51c0a0908d8997a140109a33fa09ca75141416af02be844f7945c
+  data.tar.gz: 1bb06bc6724b3fb4500e8aa8b95126f334c2d495c3624f0c579bb183c13f276ba749290051669d883b1aae6318e07e95f08d1f68b687855e720300bbd71f87cb

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.2.4] - 2024-09-xx
+## [0.2.6] - 2024-10-xx
 
 ### Added
 
@@ -10,6 +10,14 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
 
+## [0.2.5] - 2024-10-01
+
+### Added
+
+- `--no-email` option to the people sync process.
+- Helper to summarize an error Exception
+- `SendGrid` mailer
+
 ## [0.2.4] - 2024-09-05
 
 ### Added

data/eco-rake.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dotenv',         '~> 3'
   spec.add_dependency 'nokogiri',       '>= 1.13', '< 1.17'
   spec.add_dependency 'rake-commander', '~> 0.4'
+  spec.add_dependency 'sendgrid-ruby',  '~> 6.7.0'
 end

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

@@ -12,13 +12,20 @@ class EcoRake
         def task(*_args)
           return display_target_files if options[:list]
           return warn_missing_file    if target_files.empty?
+
           status = 0
           target_files.each do |file|
             delete_file(gpg_to_csv_filename(file))
-            stat   = sh_continue(decrypt_command(file, ignore_mdc_error: ignore_mdc_error))
+
+            stat   = sh_continue(
+              decrypt_command(file, ignore_mdc_error: ignore_mdc_error)
+            )
+
             status = stat unless stat.zero?
           end
-          delete_file(*target_files, message: "Deleting files from '#{source_folder}'") unless options[:simulate]
+
+          msg = "Deleting files from '#{source_folder}'"
+          delete_file(*target_files, message: msg) unless options[:simulate]
           exit status unless status.zero?
         end
 

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

@@ -5,12 +5,13 @@ class EcoRake
       # @todo ping some back-end that it was run
       #   - Should be able to log at debug level.
       class SyncLaunch < EcoRake::Lib::People::BaseTask
-        ADDITIONAL_OPTIONS = %i[only_stats no_policy simulate].freeze
+        ADDITIONAL_OPTIONS = %i[only_stats no_policy simulate no_email].freeze
         FORWARD_RULES = {
           schema:     ->(schema) { "-schema-id \"#{schema}\"" },
           only_stats: '-feed-only-stats',
           no_policy:  '-skip-batch-policy',
-          simulate:   '-simulate'
+          simulate:   '-simulate',
+          no_email:   '-no-email'
         }.freeze
 
         attr_const :target_enviro, required: true
@@ -51,9 +52,12 @@ class EcoRake
         end
 
         def missing_files_notify
-          puts "Missing files to be processed"
+          msg = "Missing files to be processed"
+          puts msg
           exit 1 if options[:simulate]
+          exit 1 if options[:no_email]
           exit 1 unless inbox = mail_to
+
           email_missing_files(enviro: target_enviro, to: inbox)
           exit 1
         end

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

@@ -9,6 +9,7 @@ class EcoRake
         option '-o', '--only-stats', TrueClass, desc: 'To display only stats in the feedback'
         option '-b', '--no-policy', FalseClass, desc: 'To skip the batch policy'
         option '-n', '--no-get', FalseClass, desc: 'Skip get people step'
+        option '-m', '--no-email', FalseClass, desc: 'Do not notify'
       end
     end
   end

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

@@ -22,6 +22,7 @@ class EcoRake
 
           sh_continue rake_sync_command
           return if options[:simulate]
+
           sh_continue rake_sftp_archive if pull_driver == 'sftp'
           sh_continue rake_files_purge('cache')
           sh_continue rake_files_purge('requests')
@@ -62,7 +63,9 @@ class EcoRake
           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)
           exit 1
         end

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

@@ -10,6 +10,7 @@ class EcoRake
           only_stats: :mirror,
           no_policy:  :mirror,
           no_get:     :mirror,
+          no_email:   :mirror,
           simulate:   :mirror
         }.freeze
 
@@ -24,7 +25,10 @@ class EcoRake
         private
 
         def rake_sync_command
-          rake_command(namespaced_task, *forward_options(*FORWARD_RULES.keys - [:enviro]))
+          rake_command(
+            namespaced_task,
+            *forward_options(*FORWARD_RULES.keys - [:enviro])
+          )
         end
 
         def rake_command(task_name, *options)

data/lib/eco-rake/option/mirror.rb

@@ -25,8 +25,10 @@ class EcoRake
         # puts "boolean_mirror (#{value}): #{opt}" if name == :no_get
 
         return nil unless [TrueClass, NilClass, FalseClass].any? {|klass| type_coercion == klass}
+
         enabled_value = !boolean_name? || [TrueClass, NilClass].any? {|klass| type_coercion == klass}
         return opt       if value == enabled_value
+
         name_false_hypen if boolean_name? && value == !enabled_value
       end
     end

data/lib/eco-rake/patches/exception.rb

@@ -0,0 +1,46 @@
+class ::Exception
+  def patch_full_message(trace_count: -1)
+    tracing   = backtrace || []
+    first_ln  = tracing[0]
+    tracing   = tracing[1..trace_count]
+    tracing   = tracing[1..30] if instance_of?(SystemStackError)
+    tracing ||= []
+
+    msg = []
+    msg << "\n#{first_ln} \n#{message} (#{self.class})"
+    tracing.each_with_index do |bt, i|
+      msg << "#{" " * 8}#{i + 1}: from #{bt}"
+    end
+
+    unless cause.nil?
+      msg << "\nCAUSE:"
+      msg << cause.patch_full_message(trace_count: trace_count)
+    end
+
+    msg.join("\n")
+  rescue StandardError => e
+    puts "Something is wrong with 'patch_full_message': #{e}"
+  end
+end
+
+# To extend an exception message preserving same exception object
+# @see https://stackoverflow.com/a/30133010/4352306
+Exception.class_eval do
+  def prepend_message(message)
+    mod = Module.new do
+      define_method :to_s do
+        String(message) + super()
+      end
+    end
+    extend mod
+  end
+
+  def append_message(message)
+    mod = Module.new do
+      define_method :to_s do
+        super() + String(message)
+      end
+    end
+    extend mod
+  end
+end

data/lib/eco-rake/patches.rb

@@ -0,0 +1,6 @@
+class EcoRake < RakeCommander
+  module Patches
+  end
+end
+
+require_relative 'patches/exception'

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

@@ -9,6 +9,7 @@ class EcoRake
       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)
@@ -18,7 +19,9 @@ class EcoRake
       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
@@ -27,6 +30,7 @@ class EcoRake
 
       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)
@@ -62,6 +66,7 @@ class EcoRake
       # @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)
@@ -76,6 +81,7 @@ class EcoRake
 
       def days_to_seconds(days)
         return nil unless days
+
         days * DAY_SECONDS
       end
     end

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

@@ -0,0 +1,71 @@
+# rubocop:disable Naming/MethodParameterName
+class EcoRake
+  module Utils
+    class Mailer
+      class AwsProvider < ProviderBase
+        def send_mail(subject:, body:, to: nil, cc: nil, bcc: nil)
+          ses.send_email(
+            destination: fetch_destination(to: to, cc: cc, bcc: bcc),
+            source:      fetch_from,
+            message:     {
+              subject: {
+                charset: "UTF-8",
+                data:    subject
+              },
+              body:    {
+                # NOTE: (html) will let you send html instead
+                # you can use both at once if you like
+                text: {
+                  charset: "UTF-8",
+                  data:    body
+                }
+              }
+            }
+          )
+        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 credentials
+          @credentials ||= {
+            id:  'MAILER_KEY_ID',
+            key: 'MAILER_ACCESS_KEY'
+          }
+        end
+
+        def ses
+          require 'aws-sdk-ses'
+          @ses ||= Aws::SES::Client.new(
+            access_key_id:     fetch_access_key_id,
+            secret_access_key: fetch_secret_access_key,
+            region:            fetch_region
+          )
+        rescue StandardError => err
+          puts "Trying to send an email with wrong email configuration: #{err}"
+        end
+
+        def fetch_destination(to: nil, cc: nil, bcc: nil)
+          {
+            to_addresses: [fetch_to(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_region
+          ENV['MAILER_REGION']
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable Naming/MethodParameterName

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

@@ -0,0 +1,48 @@
+class EcoRake
+  module Utils
+    class Mailer
+      class ProviderBase
+        class << self
+          def to_desc(to: nil, cc: nil, bcc: nil)
+            cc_to  = [cc].flatten.compact.uniq
+            bcc_to = [bcc].flatten.compact.uniq
+            { to_addresses: [to].flatten.compact.uniq }.tap do |dest|
+              dest.merge!(cc_addresses: cc_to)   unless cc_to.empty?
+              dest.merge!(bcc_addresses: bcc_to) unless bcc_to.empty?
+            end
+          end
+        end
+
+        def send_mail(subject:, body:, to: nil, cc: nil, bcc: nil) # rubocop:disable Lint/UnusedMethodArgument
+          raise "You must implement this method"
+        end
+
+        def fetch_to(value = nil)
+          value
+        end
+
+        private
+
+        def credentials
+          raise "You must implement this method"
+        end
+
+        def fetch_from(value = nil)
+          value || ENV['MAILER_FROM']
+        end
+
+        def fetch_access_key_id
+          env_mail(:id)
+        end
+
+        def fetch_secret_access_key
+          env_mail(:key)
+        end
+
+        def env_mail(prop)
+          ENV[credentials[prop]]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,110 @@
+# rubocop:disable Naming/MethodParameterName
+class EcoRake
+  module Utils
+    class Mailer
+      class SendgridProvider < ProviderBase
+        def send_mail(subject:, body:, to: nil, cc: nil, bcc: nil)
+          return false unless sendgrid
+
+          data = to_data(
+            subject: subject,
+            body:    body,
+            to:      to,
+            cc:      cc,
+            bcc:     bcc
+          )
+
+          mailer._("send").post(request_body: data)
+        end
+
+        def fetch_to(value = nil)
+          emails = [super].flatten.compact
+          to_email_model(emails)
+        end
+
+        # @return [Boolean] whether or not the mailer is configured for usage.
+        def configured?
+          fetch_secret_access_key
+        end
+
+        private
+
+        def credentials
+          @credentials ||= {
+            id:  'SENDGRID_ACCESS_ID',
+            key: 'SENDGRID_ACCESS_KEY'
+          }
+        end
+
+        def to_data(subject:, body:, to: nil, cc: nil, bcc: nil)
+          {
+            "personalizations" => [
+              {
+                "to"      => fetch_to(to).flatten,
+                "subject" => subject
+              }.tap do |pers|
+                merge_if('cc', cc, target: pers)
+                merge_if('bcc', bcc, target: pers)
+              end
+            ],
+            "from"             => fetch_from,
+            "content"          => [
+              {
+                "type"  => "text/plain",
+                "value" => body
+              }
+            ]
+          }
+        end
+
+        def mailer
+          @mailer ||= sendgrid&.client&.mail
+        end
+
+        def sendgrid
+          require 'sendgrid-ruby'
+          extend(::SendGrid) unless is_a?(SendGrid)
+
+          @sendgrid ||= SendGrid::API.new(
+            api_key: fetch_secret_access_key
+          )
+        rescue StandardError => err
+          puts "Trying to send an email with wrong email configuration: #{err}"
+        end
+
+        def to_email_model(value)
+          case value
+          when Array
+            value.map do |val|
+              to_email_model(val)
+            end.compact
+          else
+            return if value.to_s.strip.empty?
+
+            {
+              "email" => value
+            }
+          end
+        end
+
+        def merge_if(key, data, target: {})
+          return if data.to_s.strip.empty?
+
+          key_data = to_email_model(data)
+
+          return if key_data.nil?
+          return if key_data.empty?
+
+          target.merge!({key.to_s => key_data})
+        end
+
+        def fetch_from(value = nil)
+          email = [super].flatten.compact.first
+          to_email_model(email)
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable Naming/MethodParameterName

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

@@ -1,3 +1,7 @@
+require_relative 'mailer/provider_base'
+require_relative 'mailer/aws_provider'
+require_relative 'mailer/sendgrid_provider'
+
 class EcoRake
   module Utils
     # Mailer helper that uses `aws-sdk-ses` **gem** (`Aws::SES::Client`)
@@ -7,6 +11,13 @@ class EcoRake
     #   3. `MAILER_ACCESS_KEY`
     #   4. `MAILER_FROM`
     class Mailer
+      DEFAULT_PROVIDER = :sendgrid
+
+      attr_reader :provider
+      def initialize(provider: DEFAULT_PROVIDER)
+        @provider = provider || DEFAULT_PROVIDER
+      end
+
       # Sends an email
       # @param to [String] destination email address
       # @param subject [String] subject of the email
@@ -17,6 +28,7 @@ class EcoRake
           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),
@@ -37,54 +49,56 @@ class EcoRake
         ).tap do |response|
           puts "Sent email to #{to} (MessageId: #{response.message_id})"
         end
+      rescue StandardError => err
+        msg  = "The mailer generated an exception:\n"
+        msg << err.patch_full_message(trace_count: 15)
+        puts msg
       end
+      # Sends an email
+      # @param to [String] destination email address
+      # @param subject [String] subject of the email
+      # @param body [String] `html` or plain text message
+      def mail(subject:, body:, to: nil, cc: nil, bcc: nil)
+        return false unless (serv = service)
 
-      # @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?
+        unless serv.configured?
+          msg  = "Mailer: You are missing configuration parameters "
+          msg << "for '#{provider}'. Review your .env file"
+          puts msg
+          return false
         end
-      end
 
-      def fetch_from(value = nil)
-        value || ENV['MAILER_FROM']
-      end
+        serv.send_mail(
+          subject: subject,
+          body:    body,
+          to:      to,
+          cc:      cc,
+          bcc:     bcc
+        ).tap do |response|
+          next unless response
 
-      def fetch_access_key_id
-        ENV['MAILER_KEY_ID']
+          to_addr = serv.fetch_to(to)
+          msg = "Sent email #{ProviderBase.to_desc(to: to_addr, cc: cc, bcc: bcc)}"
+          puts msg
+        end
+      rescue StandardError => err
+        msg  = "The mailer generated an exception:\n"
+        msg << err.patch_full_message(trace_count: 15)
+        puts msg
       end
 
-      def fetch_secret_access_key
-        ENV['MAILER_ACCESS_KEY']
-      end
+      private
 
-      def fetch_region
-        ENV['MAILER_REGION']
+      def service
+        case provider
+        when :aws
+          AwsProvider.new
+        when :sendgrid
+          SendgridProvider.new
+        else
+          puts "Unknown mail provider '#{provider}'"
+          nil
+        end
       end
     end
   end

data/lib/eco-rake/version.rb

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

data/lib/eco-rake.rb

@@ -6,6 +6,7 @@ class EcoRake < RakeCommander
   autoload_namespace_ignore "EcoRake::Tasks"
 
   require_relative 'eco-rake/version'
+  require_relative 'eco-rake/patches'
   require_relative 'eco-rake/base'
   include EcoRake::Base
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-rake
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Oscar Segura Samper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2024-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -158,6 +158,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: sendgrid-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.7.0
 description:
 email:
 - oscar@ecoportal.co.nz
@@ -223,6 +237,8 @@ files:
 - lib/eco-rake/options/library.rb
 - lib/eco-rake/options/parental.rb
 - lib/eco-rake/options/set.rb
+- lib/eco-rake/patches.rb
+- lib/eco-rake/patches/exception.rb
 - lib/eco-rake/rake_task.rb
 - lib/eco-rake/shell.rb
 - lib/eco-rake/shell/command.rb
@@ -232,6 +248,9 @@ files:
 - lib/eco-rake/tasks.rb
 - lib/eco-rake/utils.rb
 - lib/eco-rake/utils/mailer.rb
+- lib/eco-rake/utils/mailer/aws_provider.rb
+- lib/eco-rake/utils/mailer/provider_base.rb
+- lib/eco-rake/utils/mailer/sendgrid_provider.rb
 - lib/eco-rake/utils/mailing.rb
 - lib/eco-rake/utils/timing.rb
 - lib/eco-rake/version.rb