eco-helpers 3.0.21 → 3.0.23

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.0.21
+  version: 3.0.23
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 2025-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -229,7 +229,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.7
+        version: 0.10.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -239,7 +239,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.7
+        version: 0.10.8
 - !ruby/object:Gem::Dependency
   name: ecoportal-api-graphql
   requirement: !ruby/object:Gem::Requirement
@@ -249,7 +249,7 @@ dependencies:
         version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -259,7 +259,7 @@ dependencies:
         version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.4.4
 - !ruby/object:Gem::Dependency
   name: ecoportal-api-v2
   requirement: !ruby/object:Gem::Requirement
@@ -269,7 +269,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.12
+        version: 2.0.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -279,7 +279,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.12
+        version: 2.0.15
 - !ruby/object:Gem::Dependency
   name: ed25519
   requirement: !ruby/object:Gem::Requirement
@@ -374,6 +374,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
@@ -516,6 +530,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".idea/.gitignore"
 - ".markdownlint.json"
 - ".rspec"
 - ".rubocop.yml"
@@ -541,11 +556,15 @@ files:
 - lib/eco/api/common/loaders/config/cli.rb
 - lib/eco/api/common/loaders/config/session.rb
 - lib/eco/api/common/loaders/config/workflow.rb
+- lib/eco/api/common/loaders/config/workflow/cases_extension.rb
 - lib/eco/api/common/loaders/config/workflow/mailer.rb
 - lib/eco/api/common/loaders/error_handler.rb
 - lib/eco/api/common/loaders/parser.rb
 - lib/eco/api/common/loaders/policy.rb
 - lib/eco/api/common/loaders/use_case.rb
+- lib/eco/api/common/loaders/use_case/cli_identify.rb
+- lib/eco/api/common/loaders/use_case/target_model.rb
+- lib/eco/api/common/loaders/use_case/type.rb
 - lib/eco/api/common/people.rb
 - lib/eco/api/common/people/base_parser.rb
 - lib/eco/api/common/people/default_parsers.rb
@@ -611,38 +630,47 @@ files:
 - lib/eco/api/error/handler.rb
 - lib/eco/api/error/handlers.rb
 - lib/eco/api/microcases.rb
-- lib/eco/api/microcases/account_excluded.rb
 - lib/eco/api/microcases/append_usergroups.rb
-- lib/eco/api/microcases/core_excluded.rb
-- lib/eco/api/microcases/fix_default_group.rb
-- lib/eco/api/microcases/fix_filter_tags.rb
-- lib/eco/api/microcases/people_cache.rb
-- lib/eco/api/microcases/people_load.rb
-- lib/eco/api/microcases/people_refresh.rb
-- lib/eco/api/microcases/people_search.rb
+- lib/eco/api/microcases/people.rb
+- lib/eco/api/microcases/people/apply_changes.rb
+- lib/eco/api/microcases/people/apply_changes/set_account.rb
+- lib/eco/api/microcases/people/apply_changes/set_account/account_excluded.rb
+- lib/eco/api/microcases/people/apply_changes/set_core.rb
+- lib/eco/api/microcases/people/apply_changes/set_core/core_excluded.rb
+- lib/eco/api/microcases/people/apply_changes/set_core_with_supervisor.rb
+- lib/eco/api/microcases/people/apply_changes/set_supervisor.rb
+- lib/eco/api/microcases/people/fetch.rb
+- lib/eco/api/microcases/people/fetch/with_each.rb
+- lib/eco/api/microcases/people/fetch/with_each_leaver.rb
+- lib/eco/api/microcases/people/fetch/with_each_present.rb
+- lib/eco/api/microcases/people/fetch/with_each_starter.rb
+- lib/eco/api/microcases/people/fetch/with_each_subordinate.rb
+- lib/eco/api/microcases/people/fetch/with_supervisor.rb
+- lib/eco/api/microcases/people/integrity.rb
+- lib/eco/api/microcases/people/integrity/fix_default_group.rb
+- lib/eco/api/microcases/people/integrity/fix_filter_tags.rb
+- lib/eco/api/microcases/people/integrity/refresh_default_tag.rb
+- lib/eco/api/microcases/people/macro.rb
+- lib/eco/api/microcases/people/macro/take_email.rb
+- lib/eco/api/microcases/people/manage.rb
+- lib/eco/api/microcases/people/manage/cache.rb
+- lib/eco/api/microcases/people/manage/load.rb
+- lib/eco/api/microcases/people/manage/refresh.rb
+- lib/eco/api/microcases/people/manage/search.rb
+- lib/eco/api/microcases/people/preserve.rb
+- lib/eco/api/microcases/people/preserve/default_tag.rb
+- lib/eco/api/microcases/people/preserve/filter_tags.rb
+- lib/eco/api/microcases/people/preserve/policy_groups.rb
 - lib/eco/api/microcases/person_update.rb
-- lib/eco/api/microcases/preserve_default_tag.rb
-- lib/eco/api/microcases/preserve_filter_tags.rb
-- lib/eco/api/microcases/preserve_policy_groups.rb
-- lib/eco/api/microcases/refresh_default_tag.rb
 - lib/eco/api/microcases/s3upload_targets.rb
-- lib/eco/api/microcases/set_account.rb
-- lib/eco/api/microcases/set_core.rb
-- lib/eco/api/microcases/set_core_with_supervisor.rb
-- lib/eco/api/microcases/set_supervisor.rb
 - lib/eco/api/microcases/strict_search.rb
-- lib/eco/api/microcases/take_email_from_account.rb
-- lib/eco/api/microcases/with_each.rb
-- lib/eco/api/microcases/with_each_leaver.rb
-- lib/eco/api/microcases/with_each_present.rb
-- lib/eco/api/microcases/with_each_starter.rb
-- lib/eco/api/microcases/with_each_subordinate.rb
-- lib/eco/api/microcases/with_supervisor.rb
+- lib/eco/api/microcases/with_each_contractor_present.rb
 - lib/eco/api/organization.rb
 - lib/eco/api/organization/login_providers.rb
 - lib/eco/api/organization/node_classifications.rb
 - lib/eco/api/organization/people.rb
-- lib/eco/api/organization/people_similarity.rb
+- lib/eco/api/organization/people/multiple_search_results.rb
+- lib/eco/api/organization/people/similarity.rb
 - lib/eco/api/organization/person_schemas.rb
 - lib/eco/api/organization/policy_groups.rb
 - lib/eco/api/organization/preferences.rb
@@ -660,7 +688,15 @@ files:
 - lib/eco/api/session/batch/base_policy.rb
 - lib/eco/api/session/batch/errors.rb
 - lib/eco/api/session/batch/feedback.rb
+- lib/eco/api/session/batch/feedback/generate.rb
+- lib/eco/api/session/batch/feedback/getters.rb
+- lib/eco/api/session/batch/feedback/identifiers.rb
+- lib/eco/api/session/batch/feedback/job_dependencies.rb
+- lib/eco/api/session/batch/feedback/request_stat.rb
+- lib/eco/api/session/batch/feedback/request_stats.rb
 - lib/eco/api/session/batch/job.rb
+- lib/eco/api/session/batch/job/sets.rb
+- lib/eco/api/session/batch/job/type.rb
 - lib/eco/api/session/batch/jobs.rb
 - lib/eco/api/session/batch/jobs_groups.rb
 - lib/eco/api/session/batch/launcher.rb
@@ -671,7 +707,6 @@ files:
 - lib/eco/api/session/batch/launcher/status_handling.rb
 - lib/eco/api/session/batch/launcher/valid_methods.rb
 - lib/eco/api/session/batch/policies.rb
-- lib/eco/api/session/batch/request_stats.rb
 - lib/eco/api/session/batch/searcher.rb
 - lib/eco/api/session/batch/status.rb
 - lib/eco/api/session/config.rb
@@ -693,7 +728,11 @@ files:
 - lib/eco/api/session/config/workflow.rb
 - lib/eco/api/usecases.rb
 - lib/eco/api/usecases/base_case.rb
+- lib/eco/api/usecases/base_case/model.rb
+- lib/eco/api/usecases/base_case/type.rb
 - lib/eco/api/usecases/base_io.rb
+- lib/eco/api/usecases/base_io/chaining.rb
+- lib/eco/api/usecases/base_io/validations.rb
 - lib/eco/api/usecases/cli.rb
 - lib/eco/api/usecases/cli/dsl.rb
 - lib/eco/api/usecases/cli/option.rb
@@ -759,8 +798,7 @@ files:
 - lib/eco/api/usecases/default_cases/entries_to_csv_case.rb
 - lib/eco/api/usecases/default_cases/hris_case.rb
 - lib/eco/api/usecases/default_cases/samples.rb
-- lib/eco/api/usecases/default_cases/samples/cli/sftp_cli.rb
-- lib/eco/api/usecases/default_cases/samples/sftp_case.rb
+- lib/eco/api/usecases/default_cases/samples/sftp.rb
 - lib/eco/api/usecases/default_cases/to_csv_case.rb
 - lib/eco/api/usecases/default_cases/to_csv_detailed_case.rb
 - lib/eco/api/usecases/default_cases/update_case.rb
@@ -772,6 +810,9 @@ files:
 - lib/eco/api/usecases/graphql/helpers/base/case_env.rb
 - lib/eco/api/usecases/graphql/helpers/base/error_handling.rb
 - lib/eco/api/usecases/graphql/helpers/base/graphql_env.rb
+- lib/eco/api/usecases/graphql/helpers/contractors.rb
+- lib/eco/api/usecases/graphql/helpers/contractors/base.rb
+- lib/eco/api/usecases/graphql/helpers/contractors/base/load.rb
 - lib/eco/api/usecases/graphql/helpers/location.rb
 - lib/eco/api/usecases/graphql/helpers/location/base.rb
 - lib/eco/api/usecases/graphql/helpers/location/base/classifications_parser.rb
@@ -795,6 +836,8 @@ files:
 - lib/eco/api/usecases/graphql/helpers/location/tags_remap/tags_map.rb
 - lib/eco/api/usecases/graphql/helpers/location/tags_remap/tags_set.rb
 - lib/eco/api/usecases/graphql/samples.rb
+- lib/eco/api/usecases/graphql/samples/contractors.rb
+- lib/eco/api/usecases/graphql/samples/contractors/dsl.rb
 - lib/eco/api/usecases/graphql/samples/location.rb
 - lib/eco/api/usecases/graphql/samples/location/command.rb
 - lib/eco/api/usecases/graphql/samples/location/command/dsl.rb
@@ -843,9 +886,18 @@ files:
 - lib/eco/api/usecases/ooze_samples/register_migration_case.rb
 - lib/eco/api/usecases/ooze_samples/register_update_case.rb
 - lib/eco/api/usecases/ooze_samples/target_oozes_update_case.rb
+- lib/eco/api/usecases/samples.rb
+- lib/eco/api/usecases/samples/drivers.rb
+- lib/eco/api/usecases/samples/drivers/cli/sftp_cli.rb
+- lib/eco/api/usecases/samples/drivers/cli/url_pull_cli.rb
+- lib/eco/api/usecases/samples/drivers/sftp_sample.rb
+- lib/eco/api/usecases/samples/drivers/url_pull_sample.rb
 - lib/eco/api/usecases/use_case.rb
+- lib/eco/api/usecases/use_case/chainer.rb
 - lib/eco/api/usecases/use_case_chain.rb
+- lib/eco/api/usecases/use_case_chain/chaining.rb
 - lib/eco/api/usecases/use_case_io.rb
+- lib/eco/api/usecases/use_case_io/chain.rb
 - lib/eco/assets.rb
 - lib/eco/assets/language.rb
 - lib/eco/cli.rb

data/lib/eco/api/microcases/account_excluded.rb

@@ -1,26 +0,0 @@
-module Eco
-  module API
-    class MicroCases
-      # @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 account parameters that should not be included.
-      def account_excluded(person, options)
-        [].tap do |account_excluded|
-          unless 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
-          end
-        end
-      end
-    end
-  end
-end

data/lib/eco/api/microcases/core_excluded.rb

@@ -1,20 +0,0 @@
-module Eco
-  module API
-    class MicroCases
-      # @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]
-
-          exclusions  = can_exclude.select do |attr|
-            options.dig(:exclude, attr.to_sym)
-          end
-          core_excluded.concat(exclusions)
-        end
-      end
-    end
-  end
-end

data/lib/eco/api/microcases/fix_default_group.rb

@@ -1,33 +0,0 @@
-module Eco
-  module API
-    class MicroCases
-      # If defined, it sets the default usergroup, only when the `policy_group_ids` was not part of the input data.
-      # @param entry [PersonEntry] the input entry with the data we should set on person.
-      # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
-      # @param options [Hash] the options.
-      def fix_default_group(entry, person, options)
-        return if options.dig(:exclude, :account)
-        return if options.dig(:exclude, :policy_groups) && !person.new?
-
-        end_pg_ids = person.account.policy_group_ids
-
-        if person.account_added? && __def_usergroup_id && !entry.policy_group_ids?
-          # on account creation, if missing policy_group_ids column in the input
-          # use default_usergroup, if it's defined
-          end_pg_ids = [__def_usergroup_id]
-        end
-
-        person.account.policy_group_ids = end_pg_ids
-      end
-
-      private
-
-      def __def_usergroup_id
-        @__def_usergroup_id ||=
-          if session.config.people.default_usergroup?
-            session.policy_groups.to_id(session.config.people.default_usergroup)
-          end
-      end
-    end
-  end
-end

data/lib/eco/api/microcases/fix_filter_tags.rb

@@ -1,49 +0,0 @@
-module Eco
-  module API
-    class MicroCases
-      # Helper that makes sure the **custom `tags`** are preserved.
-      # @note
-      #   - this feature is essential to preserve custom `tags` in users that have register tags.
-      #   - for this to work out, it requires a `tagtree` to be defined.
-      # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes already done.
-      # @param options [Hash] the options.
-      # @option options [Hash<Symbol, Object>] :filter_tags options around `filter_tags`.
-      #   * `:preserve_custom` (Boolean) [true] indicates if original tags that are not in the tree should be added/preserved.
-      #   * `:add_custom` (Boolean) [true] indicates if target tags that are not in the tree should be really added.
-      def fix_filter_tags(person, options)
-        return unless session.tagtree
-
-        filter_tags_excluded =
-          options.dig(:exclude, :core) ||
-          options.dig(:exclude, :filter_tags)
-
-        return if !person.new? && filter_tags_excluded
-
-        person.filter_tags = session.tagtree.user_tags(
-          initial:         person.original_doc["filter_tags"] || [],
-          final:           person.filter_tags,
-          preserve_custom: _fix_filter_tags_preserve_custom?(options),
-          add_custom:      _fix_filter_tags_add_custom?(options)
-        )
-      end
-
-      private
-
-      # default `true`
-      def _fix_filter_tags_preserve_custom?(options)
-        key_defined = options.key?(:filter_tags) && options[:filter_tags].key?(:preserve_custom)
-        return true unless key_defined
-
-        options.dig(:filter_tags, :preserve_custom)
-      end
-
-      # default `true`
-      def _fix_filter_tags_add_custom?(options)
-        key_defined = options.key?(:filter_tags) && options[:filter_tags].key?(:add_custom)
-        return true unless key_defined
-
-        options.dig(:filter_tags, :add_custom)
-      end
-    end
-  end
-end

data/lib/eco/api/microcases/people_cache.rb

@@ -1,30 +0,0 @@
-module Eco
-  module API
-    class MicroCases
-      # Helper to locally cache the people manager.
-      # @param filename [String] the name of the file where the data should be cached.
-      # @return [Eco::API::Organization::People] the `People` object with the data.
-      def people_cache(filename = enviro.config.people.cache)
-        log(:info) { "Going to get all the people via API" }
-
-        start   = Time.now
-        people  = session.batch.get_people
-        secs    = (Time.now - start).round(3)
-        cnt     = people.count
-        per_sec = (cnt.to_f / secs).round(2)
-
-        log(:info) {
-          "Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)"
-        }
-
-        file = file_manager.save_json(people, filename, :timestamp)
-
-        log(:info) {
-          "#{people.length} people loaded and saved locally to #{file}."
-        }
-
-        Eco::API::Organization::People.new(people)
-      end
-    end
-  end
-end

data/lib/eco/api/microcases/people_load.rb

@@ -1,84 +0,0 @@
-module Eco
-  module API
-    class MicroCases
-      # Helper to load `People` that works in different phases:
-      #   1. first tries to get the newest cached file that follows `filename` pattern
-      #     - if not the newest, it tries to find the specific filename
-      #   2. if it succeeds to identify a cached file, it loads it
-      #     - if it fails, it tries to get people from the server
-      # @note
-      #  - `filename` will be relative to the working directory (the one of the session `enviro` set by the user).
-      # @param filename [String] the name of the file where the cached data is to be found.
-      # @param modifier [Array<Symbol>] modifiers to specify how this function should proceed:
-      #   - `:newest` if it should try to find the newest file (pattern alike).
-      #   - `:api` if it should try to get people from the server in case there's no cache.
-      #   - `:file` if it is supposed to load people from a file.
-      #   - `:save` if it is supposed to cache/save the data locally once obtained people from the server (`:api`)
-      # @return [Eco::API::Organization::People] the `People` object with the data.
-      def people_load(filename = enviro.config.people.cache, modifier: %i[newest api]) # rubocop:disable Metrics/AbcSize
-        modifier  = [modifier].flatten
-        load_file = %i[file newest].any? {|flag| modifier.include?(flag)}
-
-        case
-        when filename && load_file
-          file = people_load_filename(filename, newest: modifier.include?(:newest))
-
-          if file
-            file_manager.load_json(file).tap do |people|
-              next unless people.is_a?(Array)
-
-              log(:info) {
-                "#{people&.length} people loaded from file #{file}"
-              }
-            end
-          else
-            log(:error) {
-              "could not find the file #{file_manager.dir.file(filename)}"
-            }
-
-            exit unless modifier.include?(:api)
-
-            people_load(modifier: modifier - %i[newest file])
-          end
-        when modifier.include?(:api)
-          log(:info) { "Going to get all the people via API (load)" }
-
-          start = Time.now
-          session.batch.get_people.tap do |people|
-            secs    = (Time.now - start).round(3)
-            cnt     = people.count
-            per_sec = (cnt.to_f / secs).round(2)
-
-            log(:info) {
-              "Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)"
-            }
-
-            if modifier.include?(:save) && people && people.length.positive?
-              file = file_manager.save_json(people, filename, :timestamp)
-              log(:info) { "#{people.length} people saved to file #{file}." }
-            end
-          end
-        end.then do |people|
-          Eco::API::Organization::People.new(people)
-        end
-      end
-
-      private
-
-      def people_load_filename(filename, newest: false)
-        if newest
-          # search input file based on pattern (in case the name has a timestamp)
-          file_manager.dir.newest_file(file: filename).tap do |file|
-            next unless file
-
-            log(:info) {
-              "previous file found: #{file}"
-            }
-          end
-        else
-          file_manager.dir.file(filename, should_exist: true)
-        end
-      end
-    end
-  end
-end

data/lib/eco/api/microcases/people_refresh.rb

@@ -1,53 +0,0 @@
-module Eco
-  module API
-    class MicroCases
-      # Helper to obtain all the elements of `people` anew from the _People Manager_.
-      # @note
-      #   1. This helper is normally used to run consecutive usecases, where data needs refresh.
-      #   2. It only includes new people if they are not dirty (they do not have pending updates)
-      #     - This contingency wouldn't be necessary if the server worked perfectly.
-      # @param people [Eco::API::Organization::People] the people that needs refresh.
-      # @param include_created [Boolean] include people created during this session? (will check `:create` batch jobs).
-      # @return [Eco::API::Organization::People] the `People` object with the data.
-      def people_refresh(people:, include_created: true) # rubocop:disable Metrics/AbcSize
-        people = people.newFrom people.select do |person|
-          !person.new? || !person.dirty?
-        end
-
-        ini = people.length
-
-        if include_created
-          session.job_groups.find_jobs(type: :create).map do |job|
-            to_add = job.people.reject(&:dirty?)
-            people = people.merge(to_add)
-          end
-        end
-
-        created = people.length - ini
-        msg    = "Going to refresh #{people.length} people with server data"
-        msg   << " (including #{created} that were created)" if created.positive?
-        log(:info) { msg }
-
-        start   = Time.now
-        entries = session.batch.get_people(people, silent: true)
-        secs    = (Time.now - start).round(3)
-        cnt     = entries.count
-        per_sec = (cnt.to_f / secs).round(2)
-
-        log(:info) {
-          "Re-loaded #{cnt} people (out of #{people.length}) in #{secs} seconds (#{per_sec} people/sec)"
-        }
-
-        missing = people.length - entries.length
-
-        if missing.positive?
-          log(:error) {
-            "Missed to obtain #{missing} people during the refresh"
-          }
-        end
-
-        Eco::API::Organization::People.new(entries)
-      end
-    end
-  end
-end