eco-helpers 2.7.24 → 3.0.0

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

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

@@ -1,3 +1,4 @@
+# rubocop:disable Metrics/BlockNesting, Layout/LineLength
 module Eco
   module API
     class MicroCases
@@ -7,21 +8,25 @@ module Eco
       #   - If `original_doc["account"]` is `nil` (no account on server side), this case will not do anything.
       #   - If the `target_email` and the `current_email` are the same or empty, this case will not do anything.
       # @note
-      #   - **It does not do the final update to the server to the `target_email`**. You will need to do this part yourself.
+      #   - **It does not do the final update to the server to the `target_email`**.
+      #     You will need to do this part yourself.
       #   - You would call this function only when you got an error of `email already taken`.
       #   - If the `target_email` is associated to a user in the same org, this will fail.
-      # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
-      # @param dest_email [String, Proc] the email that we will move the other account to, when we free up `target_email`.
+      # @param person [Ecoportal::API::V1::Person] the person we want to update,
+      #   carrying the changes to be done.
+      # @param dest_email [String, Proc] the email that we will move the other account to,
+      #   when we free up `target_email`.
       # @param target_email [String] the email that we want to free up from another account and bring to ours.
       #   If it's empty, the `person.email` will be used instead.
       # @param options [Hash] the options.
       # @param current_email [String] the email that the person's account is currently linked.
-      #   As the current email should be associated with this person's account on server side, we use `original_doc["email"]`.
+      #   As the current email should be associated with this person's account on server side,
+      #   we use `original_doc["email"]`.
       # @param context [String] main core part of logs. Provides context to the logs.
       def take_email_from_account(person, dest_email:, target_email: nil, options: {}, context: "Session")
         return false if options.dig(:exclude, :account)
-        return false unless account     = person.account
-        return false unless had_account = person.original_doc["account"]
+        return false unless (account     = person.account)
+        return false unless (had_account = person.original_doc["account"]) # rubocop:disable Lint/UselessAssignment
 
         target_email  ||= person.email
         account_email   = person.original_doc["email"]
@@ -36,16 +41,16 @@ module Eco
           return false if dest_email.to_s.strip.empty?
         end
 
-        account_json  = _take_email_account_json(account)
+        account_json = _take_email_account_json(account)
         person.email = account_email
 
-        if success = _take_email_remove_account!(person, context: context)
-          if success = _take_email_acquire_account!(person, target_email, account: {}, context: context)
-            if success = _take_email_email_free_up!(person, dest_email: dest_email, context: context)
-              if success = _take_email_remove_account!(person, context: context)
+        if (success = _take_email_remove_account!(person, context: context))
+          if (success = _take_email_acquire_account!(person, target_email, account: {}, context: context))
+            if (success = _take_email_email_free_up!(person, dest_email: dest_email, context: context))
+              if (success = _take_email_remove_account!(person, context: context))
                 # Bring back the original account
-                if success = _take_email_acquire_account!(person, account_email, account: account_json, context: context)
-                  success = true
+                if (success = _take_email_acquire_account!(person, account_email, account: account_json, context: context)) # rubocop:disable Style/SoleNestedConditional
+                  success      = true
                   person.email = target_email
                 end
               end
@@ -55,41 +60,53 @@ module Eco
               if reverted ||= _take_email_remove_account!(person, context: context)
                 reverted ||= _take_email_acquire_account!(person, account_email, account: account_json, context: context)
               end
-              puts "Could not revert back to the original account #{person.identify}" unless reverted
+
+              unless reverted
+                msg = "Could not revert back to the original account #{person.identify}"
+                log(:debug) { msg }
+                puts msg
+              end
+
               success = false
             end
           else # aquire other account
             # restore
             unless _take_email_acquire_account!(person, account_email, account: account_json, context: context)
-              puts "Could not bring back the original account we want to update the email to '#{target_email}' #{person.identify}"
+              msg = "Could not bring back the original account that "
+              msg << "we want to update the email to '#{target_email}' #{person.identify}"
+              log(:debug) { msg }
+              puts msg
             end
+
             success = false
           end
         end
+
         success
       end
 
       private
 
       def _take_email_account_json(account)
-         JSON.parse(account.to_json).tap do |hash|
-           hash.delete("user_id")
-           hash.delete("permissions_merged")
-           hash.delete("permissions_preset")
-           hash.delete("prefilter")
-           if pref = hash["preferences"]
-             hash["preferences"] = pref.reject do |attr, value|
-               attr.start_with?("kiosk")
-             end
-           end
-         end
+        JSON.parse(account.to_json).tap do |hash|
+          hash.delete("user_id")
+          hash.delete("permissions_merged")
+          hash.delete("permissions_preset")
+          hash.delete("prefilter")
+
+          if (pref = hash["preferences"])
+            hash["preferences"] = pref.reject do |attr, _value|
+              attr.start_with?("kiosk")
+            end
+          end
+        end
       end
 
       # Bring the account of the `target_email` taken, so we can change the email of this account
       def _take_email_acquire_account!(person, target_email, account: {}, context: "Session")
         person.account = account
         person.account.send_invites = false
-        person.email   = target_email
+        person.email = target_email
         micro.person_update!(person, reason: "bring account with email '#{target_email}'", context: context)
       end
 
@@ -108,3 +125,5 @@ module Eco
     end
   end
 end
+
+# rubocop:enable Metrics/BlockNesting, Layout/LineLength

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

@@ -33,6 +33,7 @@ module Eco
 
           person.entry = entry
           yield(entry, person) if block_given?
+
           scoped << person
         end.then do |all_people|
           people.newFrom all_people.uniq
@@ -45,10 +46,11 @@ module Eco
         unless error.is_a?(Eco::API::Organization::People::MultipleSearchResults)
           raise "Expecting Eco::API::Organization::People::MultipleSearchResults. Given: #{error.class}"
         end
+
         @_with_each_prompts  = 0 unless instance_variable_defined?(:@_with_each_prompts)
         @_with_each_prompts += 1 if increase_count
 
-        lines = []
+        lines  = []
         lines << "\n(#{@_with_each_prompts}) #{error}\n"
         lines << "  #index   - Select the correct person by its number index among the list above."
         lines << "  (I)      - Just Skip/Ignore this one. I will deal with that input entry in another launch."
@@ -60,20 +62,27 @@ module Eco
           res = res.upcase
 
           if res.start_with?("I")
-            logger.info "Ignoring entry... #{entry&.to_s(:identify)}"
+            log(:info) { "Ignoring entry... #{entry&.to_s(:identify)}" }
+
             nil
           elsif res.start_with?("A")
-            logger.info "All input entries with this same issue will be ignored for this launch"
+            log(:info) {
+              "All input entries with this same issue will be ignored for this launch"
+            }
+
             @_skip_all_multiple_results = true
             nil
           elsif res.start_with?("C")
-            logger.info "Creating new person...#{"for entry #{entry.to_s(:identify)}" if entry}"
+            log(:info) {
+              "Creating new person...#{"for entry #{entry.to_s(:identify)}" if entry}"
+            }
+
             session.new_person
           elsif res.start_with?("B")
             raise error
           elsif res && !res.empty? && (pos = res.to_i rescue nil) && (pos < error.candidates.length) # rubocop:disable Style/RescueModifier
             error.candidate(pos).tap do |person|
-              logger.info "Thanks!! You selected #{person.identify}"
+              log(:info) { "Thanks!! You selected #{person.identify}" }
               sleep(1.5)
             end
           else
@@ -82,6 +91,7 @@ module Eco
             else
               print "#{res} is not an option. "
             end
+
             puts "Please select one of the offered options..."
             sleep(1)
             _with_each_prompt_to_select_user(error, increase_count: false, entry: entry)

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

@@ -19,9 +19,9 @@ module Eco
             person
           end
         end.compact
+
         people.newFrom leavers
       end
-
     end
   end
 end

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

@@ -17,16 +17,20 @@ module Eco
         micro.with_each(entries, people, options) do |entry, person|
           if person.new?
             if log_starter
-              session.logger.error("This person does not exist: #{entry.to_s(:identify)}")
+              log(:error) {
+                "This person does not exist: #{entry.to_s(:identify)}"
+              }
             end
+
             next
           end
+
           found << person
           yield(entry, person) if block_given?
         end
+
         people.newFrom found
       end
-
     end
   end
 end

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

@@ -16,18 +16,22 @@ module Eco
       def with_each_starter(entries, people, options, log_present: false, append_created: true)
         starters = []
         micro.with_each(entries, people, options, append_created: append_created) do |entry, person|
-          if !person.new?
+          unless person.new?
             if log_present
-              session.logger.error("This person (id: '#{person.id}') already exists: #{entry.to_s(:identify)}")
+              log(:error) {
+                "This person (id: '#{person.id}') already exists: #{entry.to_s(:identify)}"
+              }
             end
+
             next
           end
+
           starters << person
           yield(entry, person) if block_given?
         end
+
         people.newFrom starters
       end
-
     end
   end
 end

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

@@ -28,7 +28,6 @@ module Eco
           micro.with_supervisor(value, people)&.id
         end
       end
-
     end
   end
 end

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

@@ -30,7 +30,6 @@ module Eco
           value
         end
       end
-
     end
   end
 end

data/lib/eco/api/microcases.rb

@@ -1,11 +1,9 @@
 module Eco
   module API
     class MicroCases < Eco::API::Common::Session::BaseSession
-
       def micro
         self
       end
-
     end
   end
 end

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

@@ -76,19 +76,37 @@ module Eco
           end
         end
 
-        def init_caches
+        def init_caches # rubocop:disable Metrics/AbcSize
           return if @caches_init
-          enabled_lps = self.select {|lp| lp.enabled_for != "disabled"}
-          @by_id   = enabled_lps.each_with_object({}) do |lp, hash|
+
+          enabled_lps = reject {|lp| lp.enabled_for == 'disabled'}
+
+          @by_id = enabled_lps.each_with_object({}) do |lp, hash|
             hash[lp.id.downcase] = lp
           end
+
           @by_name = enabled_lps.each_with_object({}) do |lp, hash|
             hash[lp.name.downcase] = lp
+
+            hash['magic link'] = lp if lp.type == 'onetimepassword'
           end
+
           @by_type = enabled_lps.each_with_object({}) do |lp, hash|
-            hash[lp.type.downcase.to_sym] = lp
-            hash[:sso] = lp if (!hash.key?(:sso) && lp.type == "saml")
+            type = lp.type.downcase.to_sym
+
+            hash[type] = lp unless hash.key?(type)
+
+            # only map the first :sso
+            unless hash.key?(:sso)
+              hash[:sso] = lp if lp.type == 'saml'
+            end
+
+            if lp.type == 'onetimepassword'
+              hash[:magic_link] = lp
+              hash[:magiclink]  = lp
+            end
           end
+
           @caches_init = true
         end
       end

data/lib/eco/api/session.rb

@@ -193,7 +193,7 @@ module Eco
       # @return [Eco::API::Common::People::Entries] collection of entries.
       def entries(*args, **kargs)
         entry_factory.entries(*args, **kargs).tap do |collection|
-          logger.info("Loaded #{collection.length} input entries.")
+          log(:info) { "Loaded #{collection.length} input entries." }
         end
       end
 

data/lib/eco/cli_default/input.rb

@@ -1,19 +1,20 @@
+# rubocop:disable Metrics/BlockLength
 ASSETS.cli.config do |cnf|
   formats = {
-    csv: {
-      option: ["-csv"],
+    csv:  {
+      option:  ["-csv"],
       extname: [".csv", ".txt"]
     },
-    xml: {
-      option: ["-xml"],
+    xml:  {
+      option:  ["-xml"],
       extname: [".xml"]
     },
     xls:  {
-      option: ["-xls", "-xlsx", "-excel"],
+      option:  ["-xls", "-xlsx", "-excel"],
       extname: [".xls", ".xlsx", ".xlsm"]
     },
     json: {
-      option: ["-json"],
+      option:  ["-json"],
       extname: [".json"]
     }
   }
@@ -24,10 +25,10 @@ ASSETS.cli.config do |cnf|
       file = SCR.get_file(str_opt, required: true)
 
       # Command line check
-      format = formats.reduce(nil) do |matched, (format, selectors)|
-        used = selectors[:option].reduce(false) {|used, option| SCR.get_arg(option) || used}
+      format = formats.reduce(nil) do |matched, (frm, selectors)|
+        used = selectors[:option].reduce(false) {|us, option| SCR.get_arg(option) || us}
         next matched if matched
-        next format  if used
+        next frm     if used
       end
 
       # File/Folder check
@@ -43,12 +44,12 @@ ASSETS.cli.config do |cnf|
           end
         end
       else
-        ext    = File.extname(file)
+        ext = File.extname(file)
       end
 
-      format ||= formats.reduce(nil) do |matched, (format, selectors)|
+      format ||= formats.reduce(nil) do |matched, (frm, selectors)|
         next matched if matched
-        next format  if selectors[:extname].any? {|e| ext == e}
+        next frm     if selectors[:extname].any? {|e| ext == e}
       end
       format ||= :csv
 
@@ -66,8 +67,8 @@ ASSETS.cli.config do |cnf|
       when :xls
         input = session.entries(file: file, format: format)
       when :json
-        input = [file].flatten.reduce(Eco::API::Organization::People.new([])) do |people, file|
-          people.merge(JSON.parse(File.read(file)))
+        input = [file].flatten.reduce(Eco::API::Organization::People.new([])) do |people, filename|
+          people.merge(JSON.parse(File.read(filename)))
         end
       else # :csv
         kargs = {check_headers: true}
@@ -78,3 +79,5 @@ ASSETS.cli.config do |cnf|
     input
   end
 end
+
+# rubocop:enable Metrics/BlockLength

data/lib/eco/cli_default/options.rb

@@ -2,25 +2,27 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
   cnf.options_set do |options_set, options| # rubocop:disable Metrics/BlockLength
     options_set.add("--help", "Offers a HELP") do |options, session|
       conf   = ASSETS.cli.config
+
       active = proc do |opt|
-        if there = SCR.get_arg(opt)
+        if (there = SCR.get_arg(opt))
           refine = SCR.get_arg(opt, with_param: true)
         end
         refine || there
       end
 
-      if hpf = active.call("-filters")
+      if (hpf = active.call("-filters"))
         puts conf.people_filters.help(refine: hpf)
       end
-      if hif = active.call("-input-filters")
+      if (hif = active.call("-input-filters"))
         puts conf.input_filters.help(refine: hif)
       end
-      if ho  = active.call("-options")
+      if (ho = active.call("-options"))
         puts conf.options_set.help(refine: ho)
       end
-      if huc = active.call("-usecases")
+      if (huc = active.call("-usecases"))
         puts conf.usecases.help(refine: huc)
       end
+
       puts [
         "Please specify one of the below:",
         "  -filters       to display available filters on people",
@@ -72,35 +74,44 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       session.schema = sch_id
     end
 
-    desc  = "Used to be used to specify the input file or folder when using -get-partial."
-    desc += "It can also be useful to obtain `-get-partial` of people base on `:export` use cases (i.e. -people-to-csv)"
+    desc  = "Used to be used to specify the input file or folder when using -get-partial. "
+    desc << "It can also be useful to obtain `-get-partial` of people base on `:export` use cases (i.e. -people-to-csv)"
     options_set.add("-entries-from", desc) do |options, session|
       options.deep_merge!(input: {entries_from: true})
     end
 
-    desc  = "Used to specify the input file encoding"
+    desc = "Used to specify the input file encoding"
     options_set.add("-input-encoding", desc) do |options, session|
       if encoding = SCR.get_arg("-input-encoding", with_param: true)
         options.deep_merge!(input: {file: {encoding: encoding}})
       end
     end
 
-    desc  = "Used to only get the people from the input file. It will also include their current and new supervisors."
-    options_set.add("-get-partial", desc) do |options, session|
+    desc = "Do not load any people for this run."
+    options_set.add("-no-people", desc) do |options, session|
       options.deep_merge!(people: {
-        get: {from: :remote, type: :partial}
+        get: false
       })
     end
 
-    desc  = "Do not load any people for this run."
-    options_set.add("-no-people", desc) do |options, session|
-      options.deep_merge!(people: {get: false})
+    desc  = "Used to only get the people from the input file. "
+    desc << "It will also include their current and new supervisors."
+    options_set.add("-get-partial", desc) do |options, session|
+      options.deep_merge!(people: {
+        get: {
+          from: :remote,
+          type: :partial
+        }
+      })
     end
 
     desc = "Locally cache all the people manager by retrieving from the server"
     options_set.add("-get-people", desc) do |options, session|
       options.deep_merge!(people: {
-        get: {from: :remote, type: :full}
+        get: {
+          from: :remote,
+          type: :full
+        }
       })
     end
 
@@ -110,16 +121,20 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
     end
 
     desc  = "Used to specify the cache file of people to be used. "
-    desc += "It is useful to use as people reference those stored in cached file diffrent to the last one."
+    desc << "It is useful to use as people reference those stored in cached file diffrent to the last one."
     options_set.add("-people-from-backup", desc) do |options, session|
       file = SCR.get_file("-people-from-backup", required: true, should_exist: true)
       options.deep_merge!(people: {
-        get: {from: :local, type: :file, file: file}
+        get: {
+          from: :local,
+          type: :file,
+          file: file
+        }
       })
     end
 
     desc  = "Used to export to a csv the final people (after processing). "
-    desc += "It is useful analyse the data after a -dry-run (-simulate)."
+    desc << "It is useful analyse the data after a -dry-run (-simulate)."
     options_set.add("-processed-people-to-csv", desc) do |options, session|
       file = SCR.get_file("-processed-people-to-csv", required: true, should_exist: false)
       options.deep_merge!(report: {people: {csv: file}})
@@ -138,7 +153,7 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
     end
 
     desc  = "(careful with this option)  This will include everybody as part of the update (including those that are api excluded). "
-    desc += "Only launch with this option when only api excluded people are included in your update."
+    desc << "Only launch with this option when only api excluded people are included in your update."
     options_set.add("-include-excluded", desc) do |options|
       options.deep_merge!(include: {excluded: true})
     end
@@ -169,16 +184,19 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
     end
 
     desc  = "Force search mode to 'strict' when pairing input entries with existing people."
-    desc += " Besides id and external_id it will not try to find by email unless external_id is not specified"
+    desc << " Besides id and external_id it will not try to find by email unless external_id is not specified"
     options_set.add("-search-strict", desc) do |options|
       options.deep_merge!(search: {strict: true})
     end
 
     desc  = "Search mode that will try to find people using email when id and external_id have failed"
-    desc += " This option could identify existing people by their email addresses"
-    desc += " (it should not be used in orgs where multiple people usually have the same email address)"
+    desc << " This option could identify existing people by their email addresses"
+    desc << " (it should not be used in orgs where multiple people usually have the same email address)"
     options_set.add("-search-soft", desc) do |options|
-      options.deep_merge!(search: {soft: true, strict: false})
+      options.deep_merge!(search: {
+        soft:   true,
+        strict: false
+      })
     end
 
     desc = "Prevent email to be sent (experimental)"