eco-helpers 2.7.23 → 2.7.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d522c29136b4722235f8dbf8349d7328ba7ebe90f77d5fecf15a03a049cc8fe
-  data.tar.gz: b2529b04d22fcc9f013366c07a5bb7905c8d6154af97c4d235fafc1f0bf6452b
+  metadata.gz: f48b7df545da0ca3acf06e577b40cb29cf52efd58d9ee3de743609c9e829c2df
+  data.tar.gz: 6e14955bfb6ab3d824dbc5e11d899c30a1059e1a2b37931e6970461753e2d892
 SHA512:
-  metadata.gz: 822b1359de0c56118ed2e8e564a54c1119a2bb7597373c029cc72e3f808b3fbd94853a8eced013033613f77b0cfb0c47983e4e03e60e928e30bb6084096d9250
-  data.tar.gz: f32a7ad2a927015c1a2a1b0642f379c1014231db7a2aea00187bf690584a738c7f6770ba361422eeecbf097f2b760c6c6ee502b8c6ca5d790354cef13bf58f26
+  metadata.gz: fe73ff0a71b790e686ca6bd58c553c2643cc71c99c02dd0572cc1acd29b20891a992a5edf1caa96e3d99cf622deac1ef060067f2ac3763cbc48ba1d93bfad7d5
+  data.tar.gz: 41a6f87ed1b0dfb5ad3b1fee16afb44d9d0ff8ab7ad6aabc59167003837434ecff523e0f177b7d15a96be6b8044e918084d9eeaade05b33c18bac736a4c11810

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [2.7.24] - 2024-07-xx
+## [2.7.26] - 2024-08-xx
 
 ### Added
 
@@ -10,6 +10,24 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [2.7.25] - 2024-08-01
+
+### Added
+
+- `Eco::API::Organization::LoginProviders#to_id`
+  - added support for `:magic_link` and `:magiclink`
+
+### Changed
+
+- `-get-partial` switches to full people download when it the input file surpases `MAX_GET_PARTIAL`
+
+## [2.7.24] - 2024-07-30
+
+### Fixed
+
+- `Eco::API::Common::People::PersonEntry#set_core`
+  - Exclude setting `id` (should invariably be set via back-end only)
+
 ## [2.7.23] - 2024-07-29
 
 ### Fixed
@@ -18,8 +36,6 @@ All notable changes to this project will be documented in this file.
 
 ## [2.7.22] - 2024-07-26
 
-### Added
-
 ### Changed
 
 - Patch on exception: to show cause
@@ -27,8 +43,6 @@ All notable changes to this project will be documented in this file.
   - `load_json` prevent avoidable memory leaks
   - `save_json` prevent avoidable memory leaks
 
-### Fixed
-
 ## [2.7.21] - 2024-07-13
 
 ### Added

data/lib/eco/api/common/people/person_entry.rb

@@ -211,7 +211,8 @@ module Eco
           # @param person [Ecoportal::API::V1::Person] the person we want to set the core values to.
           # @param exclude [String, Array<String>] core attributes that should not be set/changed to the person.
           def set_core(person, exclude: nil)
-            scoped_attrs = @emap.core_attrs(@final_entry) - into_a(exclude)
+            scoped_attrs  = @emap.core_attrs(@final_entry) - into_a(exclude)
+            scoped_attrs -= ['id']
             @final_entry.slice(*scoped_attrs).each do |attr, value|
               set_part(person, attr, value)
             rescue StandardError => e

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

@@ -8,6 +8,7 @@ module Eco
           alias_method :enviro, :environment
 
           include Session::Helpers
+          include Eco::Language::AuxiliarLogger
 
           def initialize(env)
             msg = "Expected object Eco::API::Common::Session::Environment. Given: #{env.class}"

data/lib/eco/api/common/session/helpers/prompt_user.rb

@@ -7,12 +7,13 @@ module Eco
             # Prompts user for input with option for default on timeout.
             def prompt_user(question, default:, explanation: "", timeout: nil)
               require 'timeout'
-              response = \
+              response =
                 if config.run_mode_remote?
                   default
                 else
                   puts explanation
                   print "#{question} "
+
                   if timeout
                     begin
                       Timeout::timeout(timeout) { STDIN.gets.chop }
@@ -24,6 +25,7 @@ module Eco
                   end
                 end
               return response unless block_given?
+
               yield(response)
             end
           end

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

@@ -5,24 +5,15 @@ module Eco
     module Common
       module Session
         module Helpers
-
           class << self
             def included(base)
               base.send(:include, InstanceMethods)
-              base.extend(ClassMethods)
             end
           end
 
-
-          module ClassMethods
-
-          end
-
           module InstanceMethods
             include Helpers::PromptUser
-            
           end
-
         end
       end
     end

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

@@ -21,6 +21,7 @@ module Eco
                 logger.formatter = format_proc(console: false) do |severity, datetime, msg, formatted_msg|
                   cache.add(severity, datetime, msg, formatted_msg)
                 end
+
                 logger.level = file_level
               end
             end
@@ -54,6 +55,7 @@ module Eco
               log_file = @enviro.file_manager.dir.file(log_file) if @enviro
               FileManager.create_directory(log_file, includes_file: true)
             end
+
             log_file
           end
         end

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

@@ -10,9 +10,11 @@ module Eco
             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

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

@@ -6,13 +6,11 @@ module Eco
       # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
       # @param options [Hash] the options.
       def append_usergroups(entry, person, options)
-        unless options.dig(:exclude, :account)
-          if person.account
-            person.account.policy_group_ids |= entry.policy_group_ids
-          end
-        end
-      end
+        return if options.dig(:exclude, :account)
+        return unless person.account
 
+        person.account.policy_group_ids |= entry.policy_group_ids
+      end
     end
   end
 end

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

@@ -7,7 +7,8 @@ module Eco
       # @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"] : ["name", "external_id", "email", "filter_tags"]
+          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

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

@@ -6,29 +6,28 @@ module Eco
       # @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)
-        unless options.dig(:exclude, :account)
-          unless options.dig(:exclude, :policy_groups) && !person.new?
-            end_pg_ids = person.account.policy_group_ids
+        return if options.dig(:exclude, :account)
+        return if options.dig(:exclude, :policy_groups) && !person.new?
 
-            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
+        end_pg_ids = person.account.policy_group_ids
 
-            person.account.policy_group_ids = end_pg_ids
-          end
+        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
+        @__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/people_cache.rb

@@ -5,17 +5,24 @@ module Eco
       # @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)
-        logger.info("Going to get all the people via API")
+        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)
-        logger.info("Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)")
+
+        log(:info) {
+          "Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)"
+        }
 
         file = file_manager.save_json(people, filename, :timestamp)
-        logger.info("#{people.length} people loaded and saved locally to #{file}.")
+
+        log(:info) {
+          "#{people.length} people loaded and saved locally to #{file}."
+        }
+
         Eco::API::Organization::People.new(people)
       end
     end

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

@@ -4,7 +4,7 @@ module Eco
       # 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 identif a cached file, it loads it
+      #   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).
@@ -25,27 +25,37 @@ module Eco
 
           if file
             file_manager.load_json(file).tap do |people|
-              logger.info("#{people&.length} people loaded from file #{file}") if people.is_a?(Array)
+              next unless people.is_a?(Array)
+
+              log(:info) {
+                "#{people&.length} people loaded from file #{file}"
+              }
             end
           else
-            logger.error("could not find the file #{file_manager.dir.file(filename)}")
+            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)
-          logger.info("Going to get all the people via API (load)")
+          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)
-            logger.info("Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)")
+
+            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)
-              logger.info("#{people.length} people saved to file #{file}.")
+              log(:info) { "#{people.length} people saved to file #{file}." }
             end
           end
         end.then do |people|
@@ -59,7 +69,11 @@ module Eco
         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|
-            logger.info("previous file found: #{file}") if file
+            next unless file
+
+            log(:info) {
+              "previous file found: #{file}"
+            }
           end
         else
           file_manager.dir.file(filename, should_exist: true)

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

@@ -26,17 +26,25 @@ module Eco
         created = people.length - ini
         msg    = "Going to refresh #{people.length} people with server data"
         msg   += " (including #{created} that were created)" if created.positive?
-        logger.info(msg)
+        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)
-        logger.info("Re-loaded #{cnt} people (out of #{people.length}) in #{secs} seconds (#{per_sec} people/sec)")
+
+        log(:info) {
+          "Re-loaded #{cnt} people (out of #{people.length}) in #{secs} seconds (#{per_sec} people/sec)"
+        }
 
         missing = people.length - entries.length
-        logger.error("Missed to obtain #{missing} people during the refresh") if missing.positive?
+
+        if missing.positive?
+          log(:error) {
+            "Missed to obtain #{missing} people during the refresh"
+          }
+        end
 
         Eco::API::Organization::People.new(entries)
       end

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

@@ -10,36 +10,43 @@ module Eco
       # @param options [Hash] the options.
       # @param silent [Boolean] `false` if low level search messages should be shown.
       # @return [Eco::API::Organization::People] the `People` object with the found persons.
-      def people_search(data, options: {}, silent: true) # rubocop:disable Metrics/AbcSize
-        session.logger.info("Going to api get #{data.length} entries...")
+      def people_search(data, options: {}, silent: true) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        log(:info) { "Going to api get #{data.length} entries..." }
 
-        silent = silent && data.count <= 500
+        silent &&= data.count <= 500
 
         start = Time.now
         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
             cnt     = people.count
             per_sec = (cnt.to_f / secs).round(2)
+
             msg     = "... could get #{cnt} people "
             msg    << "(out of #{data.length} entries) in #{secs} seconds (#{per_sec} people/sec)"
-            session.logger.info(msg)
+
+            log(:info) { msg }
           end
         end
 
         # get the supervisors of found people (current supervisors)
         supers = people_search_prepare_supers_request(people)
         if supers.length.positive?
-          session.logger.info("  Going to api get #{supers.length} current supervisors...")
+          log(:info) {
+            "  Going to api get #{supers.length} current supervisors..."
+          }
+
           start = Time.now
           people = session.batch.search(supers, silent: silent).then do |status|
             secs    = (Time.now - start).round(3)
             found   = status.people
             cnt     = found.count
             per_sec = (cnt.to_f / secs).round(2)
+
             msg     = "... could find #{cnt} current supers "
             msg    << "(out of #{supers.length}) in #{secs} seconds (#{per_sec} people/sec)"
-            session.logger.info(msg)
+            log(:info) { msg }
 
             people.merge(found, strict: micro.strict_search?(options))
           end
@@ -48,22 +55,29 @@ module Eco
         # get the supervisors referred in the input data (future supervisors)
         supers = people_search_prepare_supers_request(data, people)
         if supers.length.positive?
-          session.logger.info("  Going to api get #{supers.length} supervisors as per input entries...")
-          start = Time.now
+          log(:info) {
+            "  Going to api get #{supers.length} supervisors as per input entries..."
+          }
 
+          start = Time.now
           people = session.batch.search(supers, silent: silent).then do |status|
             secs    = (Time.now - start).round(3)
             found   = status.people
             cnt     = found.count
             per_sec = (cnt.to_f / secs).round(2)
+
             msg     = "... could find #{cnt} input supers "
             msg    << "(out of #{supers.length}) in #{secs} seconds (#{per_sec} people/sec)"
-            session.logger.info(msg)
+            log(:info) { msg }
+
             people.merge(found, strict: micro.strict_search?(options))
           end
         end
 
-        session.logger.info("Finally got #{people.length} people (out of #{data.length} entries)")
+        log(:info) {
+          "Finally got #{people.length} people (out of #{data.length} entries)"
+        }
+
         people
       end
 

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

@@ -8,8 +8,11 @@ module Eco
       # @param reason [String] why are we updating now.
       # @return [Boolean] `true` if it succeded to update, and `false` otherwise
       def person_update!(person, context: "Session", reason: "")
-        logger.debug("#{context}, going to \"#{reason}\".\nPerson: #{person_ref(person)}")
-        if response = api.people.update(person)
+        log(:debug) {
+          "#{context}, going to \"#{reason}\".\nPerson: #{person_ref(person)}"
+        }
+
+        if (response = api.people.update(person))
           if response.success?
             person.consolidate!
             true
@@ -17,14 +20,15 @@ module Eco
             msg  = "#{context} Error #{response.status}: #{response.body}\n"
             msg += " -- Failed to \"#{reason}\".\n"
             msg += "  • Person: #{person_ref(person)}"
-            logger.error(msg)
+            log(:error) { msg }
             false
           end
         else
           msg  = "#{context} Error (connection error)\n"
           msg += " -- Failed to \"#{reason}\".\n"
           msg += "  • Person: #{person_ref(person)}"
-          logger.error(msg)
+
+          log(:error) { msg }
           false
         end
       end

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

@@ -7,17 +7,17 @@ module Eco
       # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
       # @param options [Hash] the options.
       # @return [String] the final value of `default_tag`.
-      def preserve_default_tag(person, options)
-        if account = person.account
-          if account.as_update.key?("default_tag")
-            if original = person.original_doc.dig("account", "default_tag")
-              person.account.default_tag = original
-            end
-          end
+      def preserve_default_tag(person, _options)
+        return unless (account = person.account)
+
+        account.default_tag.tap do
+          next unless account.as_update.key?("default_tag")
+          next unless (original = person.original_doc.dig("account", "default_tag"))
+
+          person.account.default_tag = original
+          return original
         end
-        person.account&.default_tag
       end
-
     end
   end
 end

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

@@ -8,23 +8,23 @@ module Eco
       # @param options [Hash] the options.
       # @param keep_new [Boolean] tells if it should keep the new policy groups or get rid of them.
       # @return [String] the final value of `policy_group_ids`.
-      def preserve_policy_groups(person, options, keep_new: false)
-        if account = person.account
-          if account.as_update.key?("policy_group_ids")
-            if original = person.original_doc.dig("account", "policy_group_ids")
-              unless original.empty?
-                if keep_new
-                  person.account.policy_group_ids += original
-                else
-                  person.account.policy_group_ids  = original
-                end
-              end
-            end
+      def preserve_policy_groups(person, _options, keep_new: false)
+        return unless (account = person.account)
+
+        account.policy_group_ids.tap do
+          next unless account.as_update.key?("policy_group_ids")
+          next unless (original = person.original_doc.dig("account", "policy_group_ids"))
+          next if original.empty?
+
+          if keep_new
+            person.account.policy_group_ids += original
+          else
+            person.account.policy_group_ids  = original
           end
+
+          return account.policy_group_ids
         end
-        person.account&.policy_group_ids
       end
-
     end
   end
 end

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

@@ -8,20 +8,19 @@ module Eco
       # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
       # @param options [Hash] the options
       def refresh_default_tag(entry, person, options)
-        if person.account
-          unless options.dig(:exclude, :account)
-            unless options.dig(:exclude, :filter_tags) || options.dig(:exclude, :default_tag) || entry&.default_tag?
-              if session.tagtree
-                person.account.default_tag = session.tagtree.default_tag(*person.filter_tags)
-              else
-                tags = person.filter_tags || []
-                person.account.default_tag = tags.first unless tags.length > 1
-              end
-            end
-          end
+        return unless person.account
+        return if options.dig(:exclude, :account)
+        return if options.dig(:exclude, :filter_tags)
+        return if options.dig(:exclude, :default_tag)
+        return if entry&.default_tag?
+
+        if session.tagtree
+          person.account.default_tag = session.tagtree.default_tag(*person.filter_tags)
+        else
+          tags = person.filter_tags || []
+          person.account.default_tag = tags.first unless tags.length > 1
         end
       end
-
     end
   end
 end

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

@@ -3,14 +3,16 @@ module Eco
     class MicroCases
       # Helper to upload target files to `S3`.
       # @return [Array<String>] the paths in `S3` of the uploaded files.
-      def s3upload_targets
+      def s3upload_targets # rubocop:disable Metrics/AbcSize
         [].tap do |paths|
           session.config.s3storage.target_files.each_with_object(paths) do |file, arr|
             arr.push(session.s3upload(file: file))
           end
+
           session.config.s3storage.target_directories.each_with_object(paths) do |folder, arr|
             arr.concat(session.s3upload(directory: folder))
           end
+
           session.config.s3storage.target_file_patterns.each_with_object(paths) do |pattern, arr|
             filenames = []
             case pattern
@@ -33,7 +35,6 @@ module Eco
           end
         end
       end
-
     end
   end
 end

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

@@ -5,15 +5,14 @@ module Eco
       # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
       # @param options [Hash] the options.
       def set_account(entry, person, options)
-        unless options.dig(:exclude, :account)
-          entry.set_account(person, exclude: micro.account_excluded(person, options))
+        return if options.dig(:exclude, :account)
 
-          person.account.send_invites = options[:send_invites] if options.key?(:send_invites)
-          micro.refresh_default_tag(entry, person, options)
-          micro.fix_default_group(entry, person, options)
-        end
-      end
+        entry.set_account(person, exclude: micro.account_excluded(person, options))
 
+        person.account.send_invites = options[:send_invites] if options.key?(:send_invites)
+        micro.refresh_default_tag(entry, person, options)
+        micro.fix_default_group(entry, person, options)
+      end
     end
   end
 end

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

@@ -13,7 +13,6 @@ module Eco
         soft_option    = options.dig(:search, :soft) && !strict_option
         (strict_config || strict_option) && !soft_option
       end
-
     end
   end
 end