eco-helpers 3.0.37 → 3.1.1

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

@@ -1,213 +1,207 @@
-module Eco
-  module API
-    module Common
-      module Session
-        class SFTP
-          include Eco::Language::AuxiliarLogger
-
-          def initialize(enviro:)
-            invalid_env = enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
-            raise "Required Environment object (enviro:). Given: #{enviro}" if invalid_env
-
-            @enviro = enviro
-          end
-
-          def host
-            @host ||= fetch_host
-          end
-
-          # @see Net::SFTP::Session
-          def sftp_session
-            require "net/sftp"
-
-            @sftp_session ||= Net::SFTP.start(
-              host,
-              fetch_user,
-              **session_options
-            )
-          rescue StandardError => err
-            log(:error) {
-              "Could not open SFTP session. Possible misconfiguration: #{err}"
-            }
-            raise
-          end
-
-          # @see Net::SFTP::Operations::Dir#entries
-          def entries(path)
-            sftp_session.dir.entries(path).sort_by(&:name)
-          end
-
-          # **Files** of the remote directory.
-          # @see Net::SFTP::Operations::Dir#entries
-          # @param path [String] remote directory `path`
-          # @param pattern [Regexp] if given, filters by using this pattern
-          # @return [Array<Net::SFTP::Protocol::V01::Name>]
-          def files(path, pattern: nil)
-            entries = entries(path).select(&:file?)
-            return entries unless pattern
-
-            entries.select {|remote_file| remote_file.name =~ pattern}
-          end
-
-          # **Folders** of the remote directory.
-          # @see Net::SFTP::Operations::Dir#entries
-          # @param path [String] remote directory `path`
-          # @param pattern [Regexp] if given, filters by using this pattern
-          # @return [Array<Net::SFTP::Protocol::V01::Name>]
-          def folders(path, pattern: nil)
-            entries = entries(path).select(&:directory?)
-            return entries unless pattern
-
-            entries.select {|remote_file| remote_file.name =~ pattern}
-          end
-
-          # @see Net::SFTP::Session#rename
-          def move(fullname_source, fullname_dest, flags = 0x0001, override: true, &callback)
-            sftp_session.rename!(fullname_source, fullname_dest, flags, &callback)
-
-            true
-          rescue Net::SFTP::StatusException => err
-            case err.code
-            when Net::SFTP::Constants::StatusCodes::FX_FILE_ALREADY_EXISTS
-              log(:waning) {
-                msg  = "Remote file '#{fullname_dest}' already exists."
-                msg << "Overriding..." if override
-              }
-
-              if override
-                sftp_session.remove(fullname_dest)
-                # sftp_session.rename!(fullname_source, fullname_dest, flags, &callback)
-                move(fullname_source, fullname_dest, flags, override: false, &callback)
-              end
-            when Net::SFTP::Constants::StatusCodes::FX_PERMISSION_DENIED, Net::SFTP::Constants::StatusCodes::FX_WRITE_PROTECT
-              log(:error) {
-                "Not allowed to rename '#{fullname_source}' to '#{fullname_dest}'"
-              }
-            when Net::SFTP::Constants::StatusCodes::FX_NO_SUCH_FILE
-              log(:error) { "Remote file '#{fullname_source}' does not exist"}
-            when Net::SFTP::Constants::StatusCodes::FX_NO_SUCH_PATH
-              log(:error) { err }
-            else
-              msg = "Error when trying to move file '#{fullname_source}' to '#{fullname_dest}'"
-              log(:error) { "#{msg}\n#{err}" }
-              # raise err, msg, err.backtrace
-            end
-
-            false
-          end
-
-          # Downloads the files specified to a local folder
-          # @see Net::SFTP::Operations::Download
-          # @param files [String, Array<String>] full path to remote file(s) to be downloaded
-          # @param local_folder [String] local destination folder (`"."` if not specified)
-          # @return [Array<String>] list of created files
-          def download(files, local_folder: nil, &block)
-            puts 'Creating local files:'
-            created_files = []
-
-            [files].flatten.compact.map do |fullname|
-              basename = windows_basename(fullname)
-              dest_fullname = File.join(local_folder || '.', basename)
-              puts " * #{dest_fullname}"
-              created_files << dest_fullname
-              sftp_session.download(fullname, dest_fullname)
-            end.each(&:wait)
-
-            # run SSH event loop while dw.active?
-            created_files.tap { created_files.each(&block) }
-          end
-
-          # Upload a file to the specific `remote_folder`
-          # @return [String, FalseClass] on success returns the remote file path.
-          def upload(local_file, remote_folder:, gid: nil)
-            return false unless local_file && File.exist?(local_file)
-
-            dest_file = "#{remote_folder}/#{File.basename(local_file)}"
-            res       = sftp_session.upload!(local_file, dest_file)
-
-            unless gid.nil?
-              attrs = sftp_session.stat!(dest_file)
-              unless gid == attrs.gid
-                flags     = {permissions: 0o660, uid: attrs.uid, gid: gid}
-                _stat_res = sftp_session.setstat!(dest_file, flags)
-              end
-            end
-
-            log(:info) {
-              "Uploaded '#{local_file}' as '#{dest_file}' (#{res})"
-            }
-
-            dest_file
-          rescue StandardError
-            log(:error) {
-              "Could not upload file '#{dest_file}' (#{res})"
-            }
-            raise
-          end
-
-          private
-
-          def session_options
-            {
-              non_interactive: true
-            }.tap do |opts|
-              if password?
-                opts.merge!({password: fetch_password})
-              else
-                opts.merge!({
-                  keys:      fetch_key_files,
-                  keys_only: true
-                })
-              end
-            end
-          end
-
-          def windows_basename(remote_fullname)
-            dir_sep = /[\\\/]/
-            patr_re = /[<>:\\\/|?*]/
-
-            parts   = remote_fullname.split(dir_sep).map do |node|
-              node.gsub(patr_re, '_')
-            end
-
-            local_fullname = File.join(*parts)
-            File.basename(local_fullname)
-          end
-
-          def logger
-            @enviro&.logger ||
-              (defined?(super)? super : ::Logger.new(IO::NULL))
-          end
-
-          def config
-            @enviro.config || {}
-          end
-
-          def fetch_host
-            config.sftp.host || ENV['SFTP_HOST']
-          end
-
-          def fetch_user
-            config.sftp.user || ENV['SFTP_USERNAME']
-          end
-
-          def password?
-            !!fetch_password
-          end
-
-          def fetch_password
-            config.sftp.password || ENV['SFTP_PASSWORD']
-          end
-
-          def fetch_key_files
-            [config.sftp.key_file || ENV['SFTP_KEY_FILE']]
-          end
-
-          def fetch_base_path
-            config.sftp.base_path || ENV['SFTP_BASE_PATH']
-          end
+module Eco::API::Common::Session
+  class SFTP
+    include Eco::Language::AuxiliarLogger
+
+    def initialize(enviro:)
+      invalid_env = enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
+      raise "Required Environment object (enviro:). Given: #{enviro}" if invalid_env
+
+      @enviro = enviro
+    end
+
+    def host
+      @host ||= fetch_host
+    end
+
+    # @see Net::SFTP::Session
+    def sftp_session
+      require "net/sftp"
+
+      @sftp_session ||= Net::SFTP.start(
+        host,
+        fetch_user,
+        **session_options
+      )
+    rescue StandardError => err
+      log(:error) {
+        "Could not open SFTP session. Possible misconfiguration: #{err}"
+      }
+      raise
+    end
+
+    # @see Net::SFTP::Operations::Dir#entries
+    def entries(path)
+      sftp_session.dir.entries(path).sort_by(&:name)
+    end
+
+    # **Files** of the remote directory.
+    # @see Net::SFTP::Operations::Dir#entries
+    # @param path [String] remote directory `path`
+    # @param pattern [Regexp] if given, filters by using this pattern
+    # @return [Array<Net::SFTP::Protocol::V01::Name>]
+    def files(path, pattern: nil)
+      entries = entries(path).select(&:file?)
+      return entries unless pattern
+
+      entries.select {|remote_file| remote_file.name =~ pattern}
+    end
+
+    # **Folders** of the remote directory.
+    # @see Net::SFTP::Operations::Dir#entries
+    # @param path [String] remote directory `path`
+    # @param pattern [Regexp] if given, filters by using this pattern
+    # @return [Array<Net::SFTP::Protocol::V01::Name>]
+    def folders(path, pattern: nil)
+      entries = entries(path).select(&:directory?)
+      return entries unless pattern
+
+      entries.select {|remote_file| remote_file.name =~ pattern}
+    end
+
+    # @see Net::SFTP::Session#rename
+    def move(fullname_source, fullname_dest, flags = 0x0001, override: true, &callback)
+      sftp_session.rename!(fullname_source, fullname_dest, flags, &callback)
+
+      true
+    rescue Net::SFTP::StatusException => err
+      case err.code
+      when Net::SFTP::Constants::StatusCodes::FX_FILE_ALREADY_EXISTS
+        log(:waning) {
+          msg  = "Remote file '#{fullname_dest}' already exists."
+          msg << "Overriding..." if override
+        }
+
+        if override
+          sftp_session.remove(fullname_dest)
+          # sftp_session.rename!(fullname_source, fullname_dest, flags, &callback)
+          move(fullname_source, fullname_dest, flags, override: false, &callback)
+        end
+      when Net::SFTP::Constants::StatusCodes::FX_PERMISSION_DENIED, Net::SFTP::Constants::StatusCodes::FX_WRITE_PROTECT
+        log(:error) {
+          "Not allowed to rename '#{fullname_source}' to '#{fullname_dest}'"
+        }
+      when Net::SFTP::Constants::StatusCodes::FX_NO_SUCH_FILE
+        log(:error) { "Remote file '#{fullname_source}' does not exist"}
+      when Net::SFTP::Constants::StatusCodes::FX_NO_SUCH_PATH
+        log(:error) { err }
+      else
+        msg = "Error when trying to move file '#{fullname_source}' to '#{fullname_dest}'"
+        log(:error) { "#{msg}\n#{err}" }
+        # raise err, msg, err.backtrace
+      end
+
+      false
+    end
+
+    # Downloads the files specified to a local folder
+    # @see Net::SFTP::Operations::Download
+    # @param files [String, Array<String>] full path to remote file(s) to be downloaded
+    # @param local_folder [String] local destination folder (`"."` if not specified)
+    # @return [Array<String>] list of created files
+    def download(files, local_folder: nil, &block)
+      puts 'Creating local files:'
+      created_files = []
+
+      [files].flatten.compact.map do |fullname|
+        basename = windows_basename(fullname)
+        dest_fullname = File.join(local_folder || '.', basename)
+        puts " * #{dest_fullname}"
+        created_files << dest_fullname
+        sftp_session.download(fullname, dest_fullname)
+      end.each(&:wait)
+
+      # run SSH event loop while dw.active?
+      created_files.tap { created_files.each(&block) }
+    end
+
+    # Upload a file to the specific `remote_folder`
+    # @return [String, FalseClass] on success returns the remote file path.
+    def upload(local_file, remote_folder:, gid: nil)
+      return false unless local_file && File.exist?(local_file)
+
+      dest_file = "#{remote_folder}/#{File.basename(local_file)}"
+      res       = sftp_session.upload!(local_file, dest_file)
+
+      unless gid.nil?
+        attrs = sftp_session.stat!(dest_file)
+        unless gid == attrs.gid
+          flags     = {permissions: 0o660, uid: attrs.uid, gid: gid}
+          _stat_res = sftp_session.setstat!(dest_file, flags)
+        end
+      end
+
+      log(:info) {
+        "Uploaded '#{local_file}' as '#{dest_file}' (#{res})"
+      }
+
+      dest_file
+    rescue StandardError
+      log(:error) {
+        "Could not upload file '#{dest_file}' (#{res})"
+      }
+      raise
+    end
+
+    private
+
+    def session_options
+      {
+        non_interactive: true
+      }.tap do |opts|
+        if password?
+          opts.merge!({password: fetch_password})
+        else
+          opts.merge!({
+            keys:      fetch_key_files,
+            keys_only: true
+          })
         end
       end
     end
+
+    def windows_basename(remote_fullname)
+      dir_sep = /[\\\/]/
+      patr_re = /[<>:\\\/|?*]/
+
+      parts   = remote_fullname.split(dir_sep).map do |node|
+        node.gsub(patr_re, '_')
+      end
+
+      local_fullname = File.join(*parts)
+      File.basename(local_fullname)
+    end
+
+    def logger
+      @enviro&.logger ||
+        (defined?(super)? super : ::Logger.new(IO::NULL))
+    end
+
+    def config
+      @enviro.config || {}
+    end
+
+    def fetch_host
+      config.sftp.host || ENV['SFTP_HOST']
+    end
+
+    def fetch_user
+      config.sftp.user || ENV['SFTP_USERNAME']
+    end
+
+    def password?
+      !!fetch_password
+    end
+
+    def fetch_password
+      config.sftp.password || ENV['SFTP_PASSWORD']
+    end
+
+    def fetch_key_files
+      [config.sftp.key_file || ENV['SFTP_KEY_FILE']]
+    end
+
+    def fetch_base_path
+      config.sftp.base_path || ENV['SFTP_BASE_PATH']
+    end
   end
 end

data/lib/eco/api/common.rb

@@ -6,9 +6,6 @@ module Eco
 end
 
 require_relative 'common/version_patches'
-require_relative 'common/class_helpers'
-require_relative 'common/class_auto_loader'
-require_relative 'common/class_hierarchy'
 require_relative 'common/class_meta_basics'
 require_relative 'common/loaders'
 require_relative 'common/session'

data/lib/eco/api/custom/mailer.rb

@@ -4,7 +4,9 @@
 #    ORG = 'Org Name'
 #  end
 class Eco::API::Custom::Mailer < Eco::API::Common::Loaders::Workflow::Mailer
-  extend Eco::Language::Klass::WhenInherited
+  include Eco::Language::Klass::WhenInherited
 
-  when_inherited(&config_block)
+  when_inherited do |subclass|
+    config_apply!(on: subclass, all: true)
+  end
 end

data/lib/eco/api/error/handlers.rb

@@ -10,7 +10,7 @@ module Eco
         end
 
         # @param klass_err [Eco::API::Error] the specific error class that triggers this handler.
-        def on(klass_err, type: :error_handler, retry: true, &block)
+        def on(klass_err, type: :error_handler, &block)
           Eco::API::Error.validate_err_class(klass_err)
           raise 'Expected block but not given' unless block
 

data/lib/eco/api/microcases/people/apply_changes/set_core/core_excluded.rb

@@ -5,8 +5,14 @@ module Eco
         module ApplyChanges
           module SetCore
             module CoreExcluded
-              CAN_EXCLUDE_CREATION = %w[filter_tags archived contractor_organization_id].freeze
-              CAN_EXCLUDE_UPDATE   = %w[name external_id email filter_tags contractor_organization_id].freeze
+              CAN_EXCLUDE_CREATION = %w[
+                filter_tags archived
+                contractor_organization_id
+              ].freeze
+              CAN_EXCLUDE_UPDATE = %w[
+                name external_id email
+                filter_tags contractor_organization_id
+              ].freeze
 
               # @note by default `supervisor_id` is always excluded.
               # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.

data/lib/eco/api/microcases/people/manage/search.rb

@@ -22,7 +22,7 @@ module Eco
               people = session.batch.search(data, silent: silent).then do |status|
                 secs = (Time.now - start).round(3)
 
-                Eco::API::Organization::People.new(status.people).tap do |people| # rubocop:disable Lint/ShadowingOuterLocalVariable
+                Eco::API::Organization::People.new(status.people).tap do |people|
                   cnt     = people.count
                   per_sec = (cnt.to_f / secs).round(2)
 

data/lib/eco/api/organization/people/similarity.rb

@@ -47,7 +47,7 @@ module Eco
           # Generates a new object with same config but different base `data`.
           # @return [Eco::API::Organization::People::Similarity]
           def newFrom(data) # rubocop:disable Naming/MethodName
-            super(data).tap do |simil|
+            super.tap do |simil|
               simil.threshold = threshold
               simil.order     = order
               simil.attribute = attribute
@@ -186,7 +186,7 @@ module Eco
           # Launches a reanalyis on `analysed` based on `options`
           # @param analysed [Hash] where the _keys_ are the people `id`s and the _values_ the `Eco::Data::FuzzyMatch::Results`
           def rearrange(analysed, **options)
-            with_analysed(analysed) do |person, results|
+            with_analysed(analysed) do |_person, results|
               results.relevant_results(**options)
             end
           end
@@ -219,7 +219,7 @@ module Eco
             total   = analysed.count
             i       = 1
 
-            with_analysed(analysed) do |person, results|
+            with_analysed(analysed) do |_person, results|
               print_progress('Reanalysing by ignoring matching words', total, i)
               i += 1
               ignore_same_words_score(results, **options)