eco-helpers 3.0.26 → 3.0.28

data/lib/eco/api/error.rb

@@ -9,82 +9,82 @@ module Eco
         end
       end
 
-      @str_err = "api error on the server reply"
+      @str_err = 'api error on the server reply'
       @match   = /.*/
       #RxValidId = /[a-f0-9]{24}/
 
       class Unclassified < Eco::API::Error
-        @str_error = "Unclassified error message"
+        @str_error = 'Unclassified error message'
         @match     = /.*/
       end
 
       class InternalServerError < Eco::API::Error
-        @str_err = "Internal Server Error"
+        @str_err = 'Internal Server Error'
         @match   = /#{@str_err}/
       end
 
       class UnknownPersonId < Eco::API::Error
-        @str_err = "Unknown person id"
+        @str_err = 'Unknown person id'
         @match   = /Cannot find person with id (.*)/
       end
 
       class ExternalIdTaken < Eco::API::Error
-        @str_err = "external ID already taken"
+        @str_err = 'external ID already taken'
         @match   = /#{@str_err}/
       end
 
       class EmailMissing < Eco::API::Error
-        @str_err = "missing email for account creation"
+        @str_err = 'missing email for account creation'
         @match   = /#{@str_err}/
       end
 
       class EmailInvalid < Eco::API::Error
-        @str_err = "Email is invalid"
+        @str_err = 'Email is invalid'
         @match   = /#{@str_err}/
       end
 
       class EmailTaken < Eco::API::Error
-        @str_err   = "user email already taken"
-        @str_err_2 = "Email is already taken"
+        @str_err   = 'user email already taken'
+        @str_err_2 = 'Email is already taken'
         @match     = /(?:#{@str_err}|#{@str_err_2})/
       end
 
       class SupervisorNotFound < Eco::API::Error
-        @str_err = "Supervisor not found"
+        @str_err = 'Supervisor not found'
         @match   = /Supervisor (.*?) not found/
       end
 
       class CyclicSupervisor < Eco::API::Error
-        @str_err = "Supervisor is cyclic!"
+        @str_err = 'Supervisor is cyclic!'
         @match   = /#{@str_err}/
       end
 
       class SchemaNotFound < Eco::API::Error
-        @str_err = "Schema not found"
+        @str_err = 'Schema not found'
         @match   = /Schema (.*?) not found/
       end
 
       class InvalidObjectId < Eco::API::Error
-        @str_err = "Invalid ObjectId."
+        @str_err = 'Invalid ObjectId.'
         @match   = /'(.*?)' is an invalid ObjectId./
       end
 
       class UnknownField < Eco::API::Error
-        @str_err = "Unknown field."
+        @str_err = 'Unknown field.'
         @match   = /(.+?) is an unknown field/
 
         class UnknownCoreField < UnknownField
-          @str_err = "Unknown core field."
+          @str_err = 'Unknown core field.'
           @match   = /(.+?) is an unknown field/
         end
 
         class UnknownAccountField < UnknownField
-          @str_err = "Unknown account field."
+          @str_err = 'Unknown account field.'
           @match   = /account > (.+?) is an unknown field/
         end
 
         class UnknownDetailsField < UnknownField
-          @str_err = "Unknown details field."
+          @str_err = 'Unknown details field.'
           @match   = /details > (.+?) is an unknown field/
         end
       end

data/lib/eco/api/microcases/people/apply_changes/set_account/account_excluded.rb

@@ -12,17 +12,9 @@ module Eco
                 [].tap do |account_excluded|
                   next if person.new?
 
-                  if options.dig(:exclude, :policy_groups)
-                    account_excluded.push('policy_group_ids')
-                  end
-
-                  if options.dig(:exclude, :default_tag)
-                    account_excluded.push('default_tag')
-                  end
-
-                  if options.dig(:exclude, :login_providers)
-                    account_excluded.push('login_provider_ids')
-                  end
+                  account_excluded.push('policy_group_ids')   if options.dig(:exclude, :policy_groups)
+                  account_excluded.push('default_tag')        if options.dig(:exclude, :default_tag)
+                  account_excluded.push('login_provider_ids') if options.dig(:exclude, :login_providers)
                 end
               end
             end

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

@@ -5,13 +5,16 @@ 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
+
               # @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.
               # @param options [Hash] the options.
               # @return [Array<String>] the core parameters that should not be included.
               def core_excluded(person, options)
                 ['supervisor_id'].tap do |core_excluded|
-                  can_exclude = person.new?? ['filter_tags'] : %w[name external_id email filter_tags]
+                  can_exclude = person.new?? CAN_EXCLUDE_CREATION : CAN_EXCLUDE_UPDATE
 
                   exclusions  = can_exclude.select do |attr|
                     options.dig(:exclude, attr.to_sym)

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

@@ -93,7 +93,9 @@ module Eco
                 next if !sup_id || request.include?(spr)
 
                 micro.with_supervisor(sup_id, people) do |supervisor|
-                  request.push(spr) unless supervisor
+                  next if supervisor
+
+                  request.push(spr)
                 end
               end
             end

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

@@ -14,6 +14,7 @@ module Eco
 
         def initialize(people = [], klass: Ecoportal::API::Internal::Person)
           @klass = Ecoportal::API::Internal::Person unless klass == Ecoportal::API::V1::Person
+
           super(people, klass: @klass)
           @caches_init = false
         end

data/lib/eco/api/policies.rb

@@ -3,8 +3,8 @@ module Eco
     # @todo the autoloading happens on `add`, and there could be multiple pending children to load.
     #   This could translate into the policies not being loaded in order
     class Policies < Eco::API::UseCases
-      autoloads_children_of "Eco::API::Common::Loaders::Policy"
-      autoload_namespace_ignore "Eco::API"
+      autoloads_children_of 'Eco::API::Common::Loaders::Policy'
+      autoload_namespace_ignore 'Eco::API'
 
       attr_reader :policies
 

data/lib/eco/api/session/batch/job/sets.rb

@@ -5,6 +5,7 @@ class Eco::API::Session::Batch::Job
     class << self
       def included(base)
         super
+
         base.extend ClassMethods
       end
     end

data/lib/eco/api/session/batch/job/type.rb

@@ -5,6 +5,7 @@ class Eco::API::Session::Batch::Job
     class << self
       def included(base)
         super
+
         base.extend ClassMethods
       end
     end

data/lib/eco/api/session/batch/job.rb

@@ -313,7 +313,7 @@ module Eco
 
                 msg = "Job ('#{name}':#{type}): "
                 if (by_pass_filter = entry.external_id && @accept_update_with_no_id)
-                  msg << "entry errored on creation (failed creation)"
+                  msg << 'entry errored on creation (failed creation)'
                   msg << " but will try with person code: #{ref}"
                 else
                   msg << "excluded unexisting entry (failed creation): #{ref}"
@@ -504,7 +504,7 @@ module Eco
           def backup_update(requests, simulate: false)
             dry_run   = simulate ? '_dry_run' : ''
             dir       = config.people.requests_folder
-            filename  = name.split(' ').join('-').gsub(/[=\\\/><,"-]+/, "_") # rubocop:disable Style/RedundantArgument
+            filename  = name.split(' ').join('-').gsub(/[=\\\/><,"-]+/, '_') # rubocop:disable Style/RedundantArgument
             file      = File.join(dir, "#{type}_data_#{filename}#{dry_run}.json")
             file_manager.save_json(requests, file, :timestamp)
           end

data/lib/eco/api/session/batch/launcher/valid_methods.rb

@@ -8,8 +8,9 @@ module Eco
 
             def self.included(base)
               super
-              base.extend(ClassMethods)
-              base.send(:include, InstanceMethods)
+
+              base.extend ClassMethods
+              base.send :include, InstanceMethods
             end
 
             module ClassMethods

data/lib/eco/api/session/batch/launcher.rb

@@ -12,7 +12,7 @@ module Eco
         module Launcher
           def self.included(base)
             unless base <= Eco::API::Common::Session::BaseSession
-              msg  = "To be included only in Eco::API::Common::Session::BaseSession. "
+              msg  = 'To be included only in Eco::API::Common::Session::BaseSession. '
               msg << "Tried on '#{base}'"
               raise msg
             end
@@ -67,7 +67,6 @@ module Eco
             people_api: api&.people,
             silent:     false
           )
-
             tap_status(status: status, enviro: enviro, queue: data, method: method) do |overall_status|
               pending_for_server_error = data.to_a[0..]
 
@@ -83,7 +82,7 @@ module Eco
 
                   msg  = "starting batch '#{method}' iteration #{iteration}/#{iterations}, "
                   msg << "with #{slice.length} entries of #{data.length} -- #{done} done"
-                  msg << (" " * 20)
+                  msg << (' ' * 20)
                   log(:info) { msg } unless silent
 
                   start_slice = Time.now
@@ -92,7 +91,7 @@ module Eco
                     people_api.batch(job_mode: as_job_mode) do |batch|
                       slice.each do |person|
                         batch.public_send(method, person) do |response|
-                          faltal("Request with no response") unless response
+                          faltal('Request with no response') unless response
 
                           next if server_error?(response)
 
@@ -108,7 +107,7 @@ module Eco
                   msg  = "  ... iteration #{iteration}/#{iterations} done "
                   msg << "in #{str_per_sec(start_slice, slice.length)} "
                   msg << "(average: #{str_per_sec(start_time, done)})"
-                  msg << (" " * 20)
+                  msg << (' ' * 20)
                   log(:info) { msg } unless silent
                 end # next slice
               end

data/lib/eco/api/session/batch/searcher.rb

@@ -8,7 +8,7 @@ module Eco
         module Searcher
           def self.included(base)
             unless base <= Eco::API::Session::Batch
-              msg  = "To be included only in Eco::API::Common::Session::BaseSession. "
+              msg  = 'To be included only in Eco::API::Common::Session::BaseSession. '
               msg << "Tried on '#{base}'"
               raise msg
             end
@@ -66,7 +66,7 @@ module Eco
                 if entry.respond_to?(:email)
                   email = entry.email
                 elsif entry.respond_to?(:to_h)
-                  email = entry.to_h["email"]
+                  email = entry.to_h['email']
                 end
 
                 people_matching = []
@@ -95,8 +95,8 @@ module Eco
           private
 
           def get(params: {}, silent: false, options: self.options)
-            msg  = "cannot batch get without api connnection, "
-            msg << "please provide a valid api connection!"
+            msg  = 'cannot batch get without api connnection, '
+            msg << 'please provide a valid api connection!'
             fatal msg unless (people_api = api&.people)
 
             params = {per_page: batch_size(options)}.merge(params)

data/lib/eco/api/session/config/api.rb

@@ -236,12 +236,12 @@ module Eco
               next unless api
               next if log_connection? # prevent over-logging
 
-              msg = "Created api#{self.version(version)} connection "
+              msg  = "Created api#{self.version(version)} connection "
               msg << "on enviro #{description}, "
               msg << "pointing to '#{host}' in '#{mode}' mode"
 
               @logger.info(msg)
-              api.logger.level = ::Logger::UNKNOWN if api.respond_to?(:logger)
+              api.logger.level = ::Logger::UNKNOWN if api.respond_to?(:logger, true)
             end
           end
 

data/lib/eco/api/session/config/apis/enviro_spaces.rb

@@ -34,8 +34,8 @@ module Eco
             def apis?(space = nil)
               return apis(space).any? unless space.nil?
 
-              spaces.each_key.any? do |space|
-                apis?(space)
+              spaces.each_key.any? do |spc|
+                apis?(spc)
               end
             end
 

data/lib/eco/api/session/config/post_launch.rb

@@ -6,8 +6,8 @@ module Eco
           include Enumerable
 
           def initialize(config:)
+            super
             @postcases = []
-            super(config: config)
           end
 
           def length
@@ -15,11 +15,12 @@ module Eco
           end
 
           def empty?
-            count == 0
+            count.zero?
           end
 
           def each(&block)
             return to_enum(:each) unless block
+
             items.each(&block)
           end
 
@@ -35,7 +36,10 @@ module Eco
           end
 
           def select(usecases)
-            raise "Required Eco::API::UseCases to select the target post cases" unless usecases.is_a?(Eco::API::UseCases)
+            msg = 'Required Eco::API::UseCases to select the target post cases. '
+            msg << "Given: #{usecases.class}."
+            raise msg unless usecases.is_a?(Eco::API::UseCases)
+
             each_with_object([]) do |pc, targets|
               targets.push(usecases.case(pc[:name], type: pc[:type]))
             end
@@ -50,7 +54,6 @@ module Eco
           def by_type
             @postcases.group_by {|pc| pc[:type]}
           end
-
         end
       end
     end

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

@@ -21,7 +21,7 @@ module Eco
           end
 
           def remote_folder
-            [base_path, enviro_subpath].compact.join("/")
+            [base_path, enviro_subpath].compact.join('/')
           end
         end
       end

data/lib/eco/api/session/config/tagtree.rb

@@ -45,7 +45,7 @@ module Eco
             @tagtree ||= live_tree(**kargs).tap do |tr| # rubocop:disable Naming/MemoizedInstanceVariableName
               next if tr && !tr.empty?
 
-              msg = "Could not find a local or live locations structure."
+              msg = 'Could not find a local or live locations structure.'
               raise MissingTagtree, msg
             end
           end

data/lib/eco/api/session/config/workflow.rb

@@ -126,7 +126,7 @@ module Eco
           # @yieldreturn [Eco::API::UseCases::BaseIO] the `io` input/output object carried througout all the _workflow_
           # @return [Eco::API::Session::Config::Workflow] the current stage object (to ease chainig).
           def on(key = nil, &block)
-            msg = "A block should be given."
+            msg = 'A block should be given.'
             raise ArgumentError, msg unless block_given?
 
             if key
@@ -178,7 +178,7 @@ module Eco
           # @yieldreturn [Eco::API::UseCases::BaseIO] `io` the input/output object carried througout all the _workflow_
           # @return [Eco::API::Session::Config::Workflow] the current stage object (to ease chainig).
           def before(key = nil, &block)
-            msg = "A block should be given."
+            msg = 'A block should be given.'
             raise ArgumentError, msg unless block_given?
 
             if key
@@ -205,7 +205,7 @@ module Eco
           # @yieldreturn [Eco::API::UseCases::BaseIO] `io` the input/output object carried througout all the _workflow_
           # @return [Eco::API::Session::Config::Workflow] the current stage object (to ease chainig).
           def after(key = nil, &block)
-            msg = "A block should be given."
+            msg = 'A block should be given.'
             raise ArgumentError, msg unless block_given?
 
             if key
@@ -241,7 +241,7 @@ module Eco
           # @yieldreturn [Eco::API::UseCases::BaseIO] the `io` input/output object carried througout all the _workflow_
           # @return [Eco::API::Session::Config::Workflow] the current stage object (to ease chainig).
           def run(key = nil, io:, &block)
-            raise "Missing BaseIO object" unless io.is_a?(Eco::API::UseCases::BaseIO)
+            raise 'Missing BaseIO object' unless io.is_a?(Eco::API::UseCases::BaseIO)
 
             rescuable(io) do
               if key

data/lib/eco/api/session/config.rb

@@ -7,7 +7,7 @@ module Eco
         def initialize(name = :default)
           super(nil)
           @name = name
-          self["org"] = {}
+          self['org'] = {}
         end
 
         # @!group Config instance pure methods
@@ -30,25 +30,25 @@ module Eco
         # Helper to manage `SFTP` files and folders.
         # @return [Eco::API::Session::Config::SFTP]
         def sftp
-          self["sftp"] ||= Eco::API::Session::Config::SFTP.new(config: self)
+          self['sftp'] ||= Eco::API::Session::Config::SFTP.new(config: self)
         end
 
         # Helper to upload files and folders to `S3`.
         # @return [Eco::API::Session::Config::S3Storage]
         def s3storage
-          self["s3_storage"] ||= Eco::API::Session::Config::S3Storage.new(config: self)
+          self['s3_storage'] ||= Eco::API::Session::Config::S3Storage.new(config: self)
         end
 
         # Helper to send emails.
         # @return [Eco::API::Session::Config::Mailer]
         def mailer
-          self["mailer"] ||= Eco::API::Session::Config::Mailer.new(config: self)
+          self['mailer'] ||= Eco::API::Session::Config::Mailer.new(config: self)
         end
 
         # Helper scope reporting structures.
         # @return [Eco::API::Session::Config::TagTree]
         def tagtree_config
-          org["tagtree_config"] ||= Eco::API::Session::Config::TagTree.new(config: self)
+          org['tagtree_config'] ||= Eco::API::Session::Config::TagTree.new(config: self)
         end
         # @!endgroup
 
@@ -56,7 +56,7 @@ module Eco
 
         # @return [Eco::API::Session::Config::Logger]
         def logger
-          self["logger"] ||= Eco::API::Session::Config::Logger.new(config: self)
+          self['logger'] ||= Eco::API::Session::Config::Logger.new(config: self)
         end
 
         def log_console_level=(value)
@@ -89,7 +89,7 @@ module Eco
 
         # @return [Eco::API::Session::Config::Apis]
         def apis
-          self["apis"] ||= Eco::API::Session::Config::Apis.new(config: self)
+          self['apis'] ||= Eco::API::Session::Config::Apis.new(config: self)
         end
 
         # @return [Boolean] `true` if there is any api configuration defined, `false` otherwise
@@ -159,13 +159,13 @@ module Eco
         # @deprecated old helper to fix the dry-run mode
         # @note this is now done via `options[:dry_run]`, parsed as an option
         def dry_run!
-          self["dry-run"] = true
+          self['dry-run'] = true
         end
 
         # @deprecated old helper to check if we are in dry-run mode
         # @note this is now done via `options[:dry_run]`, which is parsed as an option
         def dry_run?
-          self["dry-run"]
+          self['dry-run']
         end
         # @!endgroup
 
@@ -173,7 +173,7 @@ module Eco
 
         # @return [Eco::API::Session::Config::Files]
         def files
-          self["files"] ||= Eco::API::Session::Config::Files.new(config: self)
+          self['files'] ||= Eco::API::Session::Config::Files.new(config: self)
         end
 
         # Defines in the base folder from where files are expected to be found when relative paths are used
@@ -225,15 +225,15 @@ module Eco
 
         # @!group Organization related shortcuts
         def org
-          self["org"]
+          self['org']
         end
 
         def location_codes=(file)
-          org["location_codes"] = file
+          org['location_codes'] = file
         end
 
         def location_codes
-          org["location_codes"]
+          org['location_codes']
         end
 
         def locations_mapper
@@ -317,7 +317,7 @@ module Eco
 
         # @return [Eco::API::Session::Config::People]
         def people
-          self["people"]     ||= Eco::API::Session::Config::People.new(config: self)
+          self['people'] ||= Eco::API::Session::Config::People.new(config: self)
         end
 
         # Define the default usergroup that should be given to people with no usergroups.
@@ -367,7 +367,7 @@ module Eco
 
         # @return [Eco::API::UseCases]
         def usecases
-          @usecases = self["usecases"] ||= Eco::API::UseCases.new
+          @usecases = self['usecases'] ||= Eco::API::UseCases.new
           if block_given?
             yield(@usecases)
             self
@@ -378,12 +378,12 @@ module Eco
 
         # @return [Eco::API::Session::Config::PostLaunch]
         def post_launch
-          self["post_launch"] ||= Eco::API::Session::Config::PostLaunch.new(config: self)
+          self['post_launch'] ||= Eco::API::Session::Config::PostLaunch.new(config: self)
         end
 
         # @return [Eco::API::Policies]
         def policies
-          @policies = self["policies"] ||= Eco::API::Policies.new
+          @policies = self['policies'] ||= Eco::API::Policies.new
 
           if block_given?
             yield(@policies)
@@ -395,7 +395,8 @@ module Eco
 
         # @return [Eco::API::Session::Batch::Policies]
         def batch_policies(&block)
-          @batch_policies = self["batch_policies"] ||= Eco::API::Session::Batch::Policies.new("batch_policy")
+          @batch_policies = self['batch_policies'] ||= Eco::API::Session::Batch::Policies.new('batch_policy')
+
           if block_given?
             @batch_policies.evaluate(@batch_policies, &block)
             self
@@ -406,7 +407,7 @@ module Eco
 
         # @return [Eco::API::Error::Handlers]
         def error_handlers
-          @error_handlers = self["error_handlers"] ||= Eco::API::Error::Handlers.new
+          @error_handlers = self['error_handlers'] ||= Eco::API::Error::Handlers.new
           if block_given?
             yield(@error_handlers)
             self
@@ -417,7 +418,7 @@ module Eco
 
         # @return [Eco::API::Session::Config::Workflow]
         def workflow
-          @workflow = self["workflow"] ||= Eco::API::Session::Config::Workflow.new(config: self)
+          @workflow = self['workflow'] ||= Eco::API::Session::Config::Workflow.new(config: self)
           @workflow.tap do |wf|
             yield(wf) if block_given?
           end
@@ -425,14 +426,14 @@ module Eco
 
         # @return [nil, Interger] seconds between jobs
         def delay_between_jobs(seconds = nil)
-          self["delay_between_jobs"] = seconds if seconds
-          self["delay_between_jobs"]
+          self['delay_between_jobs'] = seconds if seconds
+          self['delay_between_jobs']
         end
 
         # @return [nil, Interger] seconds between job groups
         def delay_between_job_groups(seconds = nil)
-          self["delay_between_job_groups"] = seconds if seconds
-          self["delay_between_job_groups"]
+          self['delay_between_job_groups'] = seconds if seconds
+          self['delay_between_job_groups']
         end
         # @!endgroup
       end

data/lib/eco/api/session.rb

@@ -7,7 +7,7 @@ module Eco
       def initialize(init = {})
         env = init
 
-        msg  = "Expected object Eco::API::Session::Config or Eco::API::Common::Session::Environment. "
+        msg  = 'Expected object Eco::API::Session::Config or Eco::API::Common::Session::Environment. '
         msg << " Given: #{init}"
 
         correct_env = env.is_a?(Session::Config) || env.is_a?(Eco::API::Common::Session::Environment)
@@ -23,7 +23,7 @@ module Eco
         @person_factories = {}
 
         log(:debug) {
-          "LINE COMMAND: #{$0} #{ARGV.join(" ")}" # rubocop:disable Style/SpecialGlobalVars
+          "LINE COMMAND: #{$0} #{ARGV.join(' ')}" # rubocop:disable Style/SpecialGlobalVars
         }
       end
 
@@ -169,7 +169,7 @@ module Eco
       # @param phase [Symbol] the phase when this parser should be active.
       # @return [Object] the parsed attribute.
       def parse_attribute(attr, source, phase = :internal, deps: {})
-        msg = "There are no parsers defined"
+        msg = 'There are no parsers defined'
         raise msg unless (parsers = entry_factory.person_parser)
 
         parsers.parse(attr, source, phase, deps: deps)
@@ -367,7 +367,7 @@ module Eco
             path = s3uploader.upload_directory(directory, recurse: recurse)
           else
             log(:error) {
-              "To use Session.s3upload, you must specify either directory, file or content and file name"
+              'To use Session.s3upload, you must specify either directory, file or content and file name'
             }
           end
           return path unless link

data/lib/eco/api/usecases/base_case/model.rb

@@ -17,7 +17,8 @@ class Eco::API::UseCases::BaseCase
     class << self
       def included(base)
         super
-        base.extend(ClassMethods)
+
+        base.extend ClassMethods
       end
     end
 

data/lib/eco/api/usecases/base_case/type.rb

@@ -21,7 +21,8 @@ class Eco::API::UseCases::BaseCase
     class << self
       def included(base)
         super
-        base.extend(ClassMethods)
+
+        base.extend ClassMethods
       end
     end