eco-helpers 3.0.37 → 3.1.1

data/lib/eco/api/common/session/mailer/sendgrid_provider.rb

@@ -1,116 +1,108 @@
 # rubocop:disable Naming/MethodParameterName
-module Eco
-  module API
-    module Common
-      module Session
-        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
-              log(:error) {
-                "Trying to send an email with wrong email configuration: #{err}"
-              }
-              nil
-            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
+class Eco::API::Common::Session::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 ||= super.merge({
+        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
-        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
+      log(:error) {
+        "Trying to send an email with wrong email configuration: #{err}"
+      }
+      nil
+    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
 

data/lib/eco/api/common/session/mailer.rb

@@ -1,91 +1,86 @@
 # rubocop:disable Naming/MethodParameterName
 
-require_relative 'mailer/provider_base'
-require_relative 'mailer/aws_provider'
-require_relative 'mailer/sendgrid_provider'
-module Eco
-  module API
-    module Common
-      module Session
-        class Mailer
-          include Eco::Language::AuxiliarLogger
-
-          DEFAULT_PROVIDER = :sendgrid
-
-          attr_reader :provider
-
-          # @param enviro [Eco::API::Common::Session::Environment]
-          def initialize(enviro:, provider: DEFAULT_PROVIDER)
-            msg = "Required Environment object (enviro:). Given: #{enviro.class}"
-            raise msg if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
-
-            @enviro   = enviro
-            @provider = provider || DEFAULT_PROVIDER
-          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)
-
-            unless serv.configured?
-              msg  = 'Mailer: You are missing configuration parameters '
-              msg << "for '#{provider}'. Review your .env file"
-              log(:error) { msg }
-              return false
-            end
-
-            serv.send_mail(
-              subject: subject,
-              body:    body,
-              to:      to,
-              cc:      cc,
-              bcc:     bcc
-            ).tap do |response|
-              next unless response
-
-              to_addr = serv.fetch_to(to)
-              msg     = "Sent email #{ProviderBase.to_desc(
-                to:  to_addr,
-                cc:  cc,
-                bcc: bcc
-              )}"
-
-              puts msg
-              log(:debug) { msg }
-            end
-          end
-
-          private
-
-          def service
-            case provider
-            when :aws
-              AwsProvider.new(config, logger: logger)
-            when :sendgrid
-              SendgridProvider.new(config, logger: logger)
-            else
-              msg = "Unknown mail provider '#{provider}'"
-              puts msg
-              log(:debug) { msg }
-
-              nil
-            end
-          end
-
-          def logger
-            @enviro&.logger || super
-          end
-
-          def config
-            @enviro.config || {}
-          end
-        end
+module Eco::API::Common::Session
+  class Mailer
+    include Eco::Language::AuxiliarLogger
+
+    DEFAULT_PROVIDER = :sendgrid
+
+    attr_reader :provider
+
+    # @param enviro [Eco::API::Common::Session::Environment]
+    def initialize(enviro:, provider: DEFAULT_PROVIDER)
+      msg = "Required Environment object (enviro:). Given: #{enviro.class}"
+      raise msg if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
+
+      @enviro   = enviro
+      @provider = provider || DEFAULT_PROVIDER
+    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)
+
+      unless serv.configured?
+        msg  = 'Mailer: You are missing configuration parameters '
+        msg << "for '#{provider}'. Review your .env file"
+        log(:error) { msg }
+        return false
+      end
+
+      serv.send_mail(
+        subject: subject,
+        body:    body,
+        to:      to,
+        cc:      cc,
+        bcc:     bcc
+      ).tap do |response|
+        next unless response
+
+        to_addr = serv.fetch_to(to)
+        msg     = "Sent email #{ProviderBase.to_desc(
+          to:  to_addr,
+          cc:  cc,
+          bcc: bcc
+        )}"
+
+        puts msg
+        log(:debug) { msg }
+      end
+    end
+
+    private
+
+    def service
+      case provider
+      when :aws
+        AwsProvider.new(config, logger: logger)
+      when :sendgrid
+        SendgridProvider.new(config, logger: logger)
+      else
+        msg = "Unknown mail provider '#{provider}'"
+        puts msg
+        log(:debug) { msg }
+
+        nil
       end
     end
+
+    def logger
+      @enviro&.logger || super
+    end
+
+    def config
+      @enviro.config || {}
+    end
   end
 end
 
+require_relative 'mailer/provider_base'
+require_relative 'mailer/aws_provider'
+require_relative 'mailer/sendgrid_provider'
+
 # rubocop:enable Naming/MethodParameterName

data/lib/eco/api/common/session/s3_uploader.rb

@@ -1,143 +1,137 @@
-module Eco
-  module API
-    module Common
-      module Session
-        class S3Uploader
-          include Eco::Language::AuxiliarLogger
-
-          attr_reader :prefix
-
-          # @param enviro [Eco::API::Common::Session::Environment]
-          def initialize(enviro:)
-            msg = "Required Environment object (enviro:). Given: #{enviro.class}"
-            raise msg if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
-
-            @enviro    = enviro
-            @prefix    = fetch_prefix
-            @timestamp = Time.now.iso8601
-          end
-
-          # Uploads `content` to S3 as `filename`
-          # @param filename [String] the name of the object to be created on S3
-          # @param content [String] that to be uploaded
-          # @return [String] S3 path to the uploaded `filename` object
-          def upload(filename, content)
-            if (obj = new_s3_object(filename))
-              log_upload(obj) do
-                obj.put(body: content)
-              end
-            end
-
-            full_path(obj)
-          end
-
-          # Uploads a single file
-          # @param path [String] the target file to be uploaded
-          # @return [String] S3 path to the uploaded `path` file
-          def upload_file(path)
-            return unless File.exist?(path)
-
-            File.open(path, "rb") do |f|
-              upload(File.basename(path), f)
-            end
-          end
-
-          # @note it will skip subfolders
-          # @param path [String] the target directory to be uploaded
-          # @param recurse [Boolean] deepen in the folder structure? (`false`: default)
-          # @return [Array<String>] S3 paths to all the uploaded files of `path` directory
-          def upload_directory(path, recurse: false)
-            path      = File.expand_path(path)
-            prefix    = File.expand_path(File.join(path, ".."))
-            wildcard  = recurse ? "**/*" : "*"
-
-            Dir.glob(File.join(path, wildcard)).sort.map do |file|
-              next unless File.file?(file) # Skip directories
-              key = file.sub(prefix, "").gsub(/\\/, "/").sub(/^\/+/, "")
-
-              File.open(file, "rb") do |f|
-                upload(key, f)
-              end
-            end.compact
-          end
-
-          # @param path [String] a full path to a S3 object
-          # @return [String] `link` to the S3 object on console
-          def link(path)
-            return path.map { |pth| link(pth) } if path.is_a?(Enumerable)
-            return unless path.is_a?(String)
-
-            s3_path_str = "https://s3.console.aws.amazon.com/s3/object"
-            s3_params   = "region=#{fetch_region}&tab=overview"
-            "#{s3_path_str}/#{path.sub('s3://', '')}?#{s3_params}"
-          end
-
-          private
-
-          def full_path(obj)
-            "s3://#{bucket.name}/#{obj.key}" if obj
-          end
-
-          def bucket
-            require 'aws-sdk-s3'
-            begin
-              @bucket ||= Aws::S3::Resource.new(
-                access_key_id:     fetch_access_key_id,
-                secret_access_key: fetch_secret_access_key,
-                region:            fetch_region
-              ).bucket(fetch_bucket)
-            rescue StandardError => err
-              log(:error) {
-                "Trying to upload to S3 with wrong configuration: #{err}"
-              }
-            end
-            @bucket
-          end
-
-          def session_path
-            ["scripts", @prefix, @timestamp].join("/")
-          end
-
-          def new_s3_object(filename)
-            file_path = [session_path, filename].join("/")
-            bucket&.object(file_path)
-          end
-
-          def log_upload(obj)
-            yield
-
-            log(:debug) { "Uploaded #{full_path(obj)}" }
-          end
-
-          def logger
-            @enviro&.logger || super
-          end
-
-          def config
-            @enviro.config || {}
-          end
-
-          def fetch_bucket
-            config.s3storage.bucket_name
-          end
-
-          def fetch_prefix
-            config.s3storage.prefix
-          end
-
-          def fetch_access_key_id
-            config.s3storage.access_key_id || ENV['AWS_ACCESS_KEY_ID']
-          end
-
-          def fetch_secret_access_key
-            config.s3storage.secret_access_key || ENV['AWS_SECRET_ACCESS_KEY']
-          end
-
-          def fetch_region
-            config.s3storage.region || ENV['AWS_REGION']
-          end
+module Eco::API::Common::Session
+  class S3Uploader
+    include Eco::Language::AuxiliarLogger
+
+    attr_reader :prefix
+
+    # @param enviro [Eco::API::Common::Session::Environment]
+    def initialize(enviro:)
+      msg = "Required Environment object (enviro:). Given: #{enviro.class}"
+      raise msg if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
+
+      @enviro    = enviro
+      @prefix    = fetch_prefix
+      @timestamp = Time.now.iso8601
+    end
+
+    # Uploads `content` to S3 as `filename`
+    # @param filename [String] the name of the object to be created on S3
+    # @param content [String] that to be uploaded
+    # @return [String] S3 path to the uploaded `filename` object
+    def upload(filename, content)
+      if (obj = new_s3_object(filename))
+        log_upload(obj) do
+          obj.put(body: content)
+        end
+      end
+
+      full_path(obj)
+    end
+
+    # Uploads a single file
+    # @param path [String] the target file to be uploaded
+    # @return [String] S3 path to the uploaded `path` file
+    def upload_file(path)
+      return unless File.exist?(path)
+
+      File.open(path, "rb") do |f|
+        upload(File.basename(path), f)
+      end
+    end
+
+    # @note it will skip subfolders
+    # @param path [String] the target directory to be uploaded
+    # @param recurse [Boolean] deepen in the folder structure? (`false`: default)
+    # @return [Array<String>] S3 paths to all the uploaded files of `path` directory
+    def upload_directory(path, recurse: false)
+      path      = File.expand_path(path)
+      prefix    = File.expand_path(File.join(path, ".."))
+      wildcard  = recurse ? "**/*" : "*"
+
+      Dir.glob(File.join(path, wildcard)).sort.map do |file|
+        next unless File.file?(file) # Skip directories
+        key = file.sub(prefix, "").gsub(/\\/, "/").sub(/^\/+/, "")
+
+        File.open(file, "rb") do |f|
+          upload(key, f)
         end
+      end.compact
+    end
+
+    # @param path [String] a full path to a S3 object
+    # @return [String] `link` to the S3 object on console
+    def link(path)
+      return path.map { |pth| link(pth) } if path.is_a?(Enumerable)
+      return unless path.is_a?(String)
+
+      s3_path_str = "https://s3.console.aws.amazon.com/s3/object"
+      s3_params   = "region=#{fetch_region}&tab=overview"
+      "#{s3_path_str}/#{path.sub('s3://', '')}?#{s3_params}"
+    end
+
+    private
+
+    def full_path(obj)
+      "s3://#{bucket.name}/#{obj.key}" if obj
+    end
+
+    def bucket
+      require 'aws-sdk-s3'
+      begin
+        @bucket ||= Aws::S3::Resource.new(
+          access_key_id:     fetch_access_key_id,
+          secret_access_key: fetch_secret_access_key,
+          region:            fetch_region
+        ).bucket(fetch_bucket)
+      rescue StandardError => err
+        log(:error) {
+          "Trying to upload to S3 with wrong configuration: #{err}"
+        }
       end
+      @bucket
+    end
+
+    def session_path
+      ["scripts", @prefix, @timestamp].join("/")
+    end
+
+    def new_s3_object(filename)
+      file_path = [session_path, filename].join("/")
+      bucket&.object(file_path)
+    end
+
+    def log_upload(obj)
+      yield
+
+      log(:debug) { "Uploaded #{full_path(obj)}" }
+    end
+
+    def logger
+      @enviro&.logger || super
+    end
+
+    def config
+      @enviro.config || {}
+    end
+
+    def fetch_bucket
+      config.s3storage.bucket_name
+    end
+
+    def fetch_prefix
+      config.s3storage.prefix
+    end
+
+    def fetch_access_key_id
+      config.s3storage.access_key_id || ENV['AWS_ACCESS_KEY_ID']
+    end
+
+    def fetch_secret_access_key
+      config.s3storage.secret_access_key || ENV['AWS_SECRET_ACCESS_KEY']
+    end
+
+    def fetch_region
+      config.s3storage.region || ENV['AWS_REGION']
     end
   end
 end