eco-helpers 2.7.24 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6576d3f9439855c0004110d104d82634733df41822acb362bc82cafcbf90d6ca
-  data.tar.gz: e0052851a9c33b54c77bcb4577874cb765e744c40ed63b7eaa5a5fd3d59632ec
+  metadata.gz: f87b772a3ca7272d32299e202d5f0a500f4e814b5281e00d2e49484a52fa42df
+  data.tar.gz: dde02113e49cc438157123b892b5ab2e747707f824ec0b228240a1f8aacebe29
 SHA512:
-  metadata.gz: 479a0ed0a903b1f05a930673e0098912df91cb66a49b1acb99d2b7c82dd531f9bcd4704f46c0a4a84ad9f8c2e12a0469ccbc1b8760cba65fae1e7e272d6575aa
-  data.tar.gz: 5f626293d3de079368627f68eb5337abe64afde56f86248721ed3615a90d7e694cacde99fe78467e50fb4c24a8d19cb66670cffc14f63c08ab1b4735d9652041
+  metadata.gz: 3cc9947ab00adc1881db3a69cbe0873b5a2ec1275c92d3127f5826b5acb96db5b9b72cdc4297a0658172cdd321cdd46c4f02fddb7b93f05296ad2d2be2509298
+  data.tar.gz: '0330899821bab587d827d9079638e9cef5528f8c01e68aab5379e7d358b9de7dffb18ed6b49f12268737b953c4bb95419cbf0c4816b96dcf819d03857880d451'

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.7.8
+  TargetRubyVersion: 3.2.2
   Exclude:
     - 'config/routes.rb'
   NewCops: enable

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -2,14 +2,29 @@
 
 All notable changes to this project will be documented in this file.
 
-## [2.7.25] - 2024-07-xx
+## [3.0.0] - 2024-08-01
 
 ### Added
 
 ### Changed
 
+- require `ruby 3`
+
 ### Fixed
 
+- have `Eco::VERSION` defined
+
+## [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

data/eco-helpers.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "./lib/eco/version"
@@ -9,12 +9,14 @@ Gem::Specification.new do |spec|
   spec.platform      = Gem::Platform::RUBY
   spec.authors       = ["Oscar Segura"]
   spec.email         = ["oscar@ecoportal.co.nz"]
-  spec.date          = %q{2018-09-05}
-  spec.summary       = %q(eco-helpers to manage people api cases)
+
+  spec.summary       = "eco-helpers to manage people api cases"
   spec.homepage      = "https://www.ecoportal.com"
   spec.licenses      = %w[MIT]
 
-  spec.required_ruby_version = '>= 2.7.2'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.required_ruby_version = '>= 3.2.2'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -24,7 +26,6 @@ Gem::Specification.new do |spec|
   #spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",   ">= 2.4.12", "< 3"
   spec.add_development_dependency "rake",      ">= 13.0.3", "< 14"
   spec.add_development_dependency "redcarpet", ">= 3.6.0",  "< 4"
   spec.add_development_dependency "rspec",     ">= 3.12.0", "< 4"
@@ -32,15 +33,15 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-rake", "~> 0"
   spec.add_development_dependency "yard",      ">= 0.9.34", "< 1"
 
-  spec.add_dependency 'amatch',        '>= 0.4.1',  '< 0.5'
+  spec.add_dependency 'amatch',        '>= 0.4.1', '< 0.5'
   spec.add_dependency 'aws-sdk-s3',    '>= 1.142.0', '< 2'
   spec.add_dependency 'aws-sdk-ses',   '>= 1.58.0', '< 2'
   spec.add_dependency 'bcrypt_pbkdf',  '~> 1.0'
-  spec.add_dependency 'docx',          '>= 0.8.0',  '< 0.9'
-  spec.add_dependency 'dotenv',        '>= 2.8.1',  '< 3'
-  spec.add_dependency 'ecoportal-api',         '>= 0.9.8', '< 0.10'
-  spec.add_dependency 'ecoportal-api-graphql', '>= 0.3.18', '< 0.4'
-  spec.add_dependency 'ecoportal-api-v2',      '>= 1.1.8', '< 1.2'
+  spec.add_dependency 'docx',          '>= 0.8.0', '< 0.9'
+  spec.add_dependency 'dotenv',        '~> 3'
+  spec.add_dependency 'ecoportal-api',         '~> 0.10'
+  spec.add_dependency 'ecoportal-api-graphql', '~> 0.4'
+  spec.add_dependency 'ecoportal-api-v2',      '~> 2.0'
   spec.add_dependency 'ed25519',       '~> 1.2'
   spec.add_dependency 'fast_excel',    '>= 0.5.0',  '< 0.6'
   spec.add_dependency 'fuzzy_match',   '>= 2.1.0',  '< 2.2'

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