eco-helpers 2.0.15 → 2.0.21

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

@@ -210,13 +210,13 @@ module Eco
           # @param exclude [String, Array<String>] account properties that should not be set/changed to the person.
           def set_account(person, exclude: nil)
             person.account = {} if !person.account
-            person.account.permissions_preset = nil unless person.account.permissions_preset = "custom"
             scoped_attrs = @emap.account_attrs - into_a(exclude)
             @final_entry.slice(*scoped_attrs).each do |attr, value|
               set_part(person.account, attr, value)
             end
           end
 
+          # TO DO: use person.details.schema_id to switch @emap and @person_parser (or just crash if they don't match?)
           # Setter to fill in all the schema `details` fields of the `Person` that are present in the `Entry`.
           # @note it only sets those details properties defined in the entry.
           #  Meaning that if an details property is not present in the entry, this will not be set on the target person.
@@ -290,7 +290,10 @@ module Eco
           # @param internal_entry [Hash] entry with **internal** names and values, but **external** types.
           # @return [Hash] entry with **internal** names and **external** values and types.
           def _mapped_serializing(internal_entry)
-            internal_entry.merge(_serialize_values(internal_entry, :internal))
+            mapped_hash = internal_entry.merge(_serialize_values(internal_entry, :internal))
+            model_attrs = @person_parser.all_model_attrs - ["send_invites"]
+            aux_hash    = mapped_hash.slice(*model_attrs)
+            merge_missing_attrs(aux_hash, mapped_hash)
           end
 
           # Parsing helper that just **parses the values** that have a parser/serializer defined.

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

@@ -15,6 +15,7 @@ module Eco
             # Reorders as follows:
             #   1. supervisors, people with no supervisor or where their supervisor not present
             #   2. subordinates
+            # @return [Array<Entry>] `values` sorted by supervisors/subordinates
             def sort_by_supervisors(values, supervisors_first: true)
               raise "Expected non hash Enumerable. Given: #{values.class}" if values.is_a?(Hash)
               return [] unless values && values.is_a?(Enumerable)
@@ -32,6 +33,32 @@ module Eco
               roam.call(supervisors_tree(values))
             end
 
+            # Identifies all the cyclic supervisor chains
+            # @note as `supervisors_tree` will have any entry involved in a cycle at the top, it just checks all the top entries against their offspring
+            # @return [Array<Array>] the sets of entries that are cyclic
+            def identify_cyclic_chains(values)
+              raise "Expected non hash Enumerable. Given: #{values.class}" if values.is_a?(Hash)
+              return [] unless values && values.is_a?(Enumerable)
+
+              identify  = Proc.new do |top_sup, offspring, chain = [top_sup]|
+                next [] if offspring.empty?
+                offspring.each_with_object([]) do |(sup, subordinates), set|
+                  break set unless set.empty?
+                  if top_sup.supervisor_id == sup.id
+                    set.concat(chain, [sup])
+                  else
+                    set = identify.call(top_sup, subordinates, chain | [sup])
+                  end
+                end
+              end
+
+              supervisors_tree(values).each_with_object([]) do |(top_sup, offspring), sets|
+                if (set = identify.call(top_sup, offspring)) && !set.empty?
+                  sets.push(set)
+                end
+              end
+            end
+
             def tree_to_str(tree, lev: 0)
               raise "Required Hash tree structure. Given: #{tree.class}" unless tree.is_a?(Hash)
               "".tap do |str|

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

@@ -13,4 +13,5 @@ require_relative 'session/sftp'
 require_relative 'session/s3_uploader'
 require_relative 'session/file_manager'
 require_relative 'session/environment'
+require_relative 'session/helpers'
 require_relative 'session/base_session'

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

@@ -11,6 +11,8 @@ module Eco
           attr_reader  :api, :file_manager, :logger
           alias_method :fm, :file_manager
 
+          include Session::Helpers
+          
           def initialize(e)
             raise "Expected object Eco::API::Common::Session::Environment. Given: #{e.class}" unless e.is_a?(Environment)
             self.environment = e

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

@@ -20,8 +20,8 @@ module Eco
             begin
               @dir = Eco::Data::Files::Directory.new(value)
               @dir_path = @dir.create
-            rescue
-              logger.error("could not create or make any sense of directory '#{value}'")
+            rescue Exception => e
+              logger.error("could not create or make any sense of directory '#{value}': #{e.to_s}")
             end
           end
 

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

@@ -0,0 +1,30 @@
+require_relative 'helpers/prompt_user'
+
+module Eco
+  module API
+    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
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'timeout'
+module Eco
+  module API
+    module Common
+      module Session
+        module Helpers
+          module PromptUser
+
+            def prompt_user(question, default:, explanation: "", timeout: nil)
+              response = if config.run_mode_remote?
+                          default
+                        else
+                          puts explanation
+                          print "#{question} "
+                          if timeout
+                            begin
+                              Timeout::timeout(timeout) { STDIN.gets.chop }
+                            rescue Timeout::Error
+                              default
+                            end
+                          else
+                            STDIN.gets.chop
+                          end
+                        end
+              return response unless block_given?
+              yield(response)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,4 @@
 require 'aws-sdk-ses'
-require 'dotenv/load'
 
 module Eco
   module API

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

@@ -1,5 +1,4 @@
 require 'aws-sdk-s3'
-require 'dotenv/load'
 
 module Eco
   module API

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

@@ -1,5 +1,4 @@
 require "net/sftp"
-require 'dotenv/load'
 
 module Eco
   module API

data/lib/eco/api/common/version_patches/ecoportal_api/external_person.rb

@@ -18,7 +18,7 @@ module Ecoportal
             entry.to_s(:identify)
           else
             str_id = id ? "id: '#{id}'; " : ""
-            "#{name}' (#{str_id}ext_id: '#{external_id}'; email: '#{email}')"
+            "'#{name}' (#{str_id}ext_id: '#{external_id}'; email: '#{email}')"
           end
         end
 

data/lib/eco/api/common/version_patches/ecoportal_api/internal_person.rb

@@ -11,12 +11,15 @@ module Ecoportal
           original_doc["account"] = JSON.parse(doc["account"])
         end
 
-        def new?
-          !initial_doc["details"] && !initial_doc["account"]
+        def new?(doc = :initial)
+          ref_doc = (doc == :original) ? original_doc : initial_doc
+          !ref_doc["details"] && !ref_doc["account"]
         end
 
-        def account_added?
-          account && !initial_doc["account"]
+        # @return [Boolean] if the account has been added, compared to `doc`
+        def account_added?(doc = :initial)
+          ref_doc = (doc == :original) ? original_doc : initial_doc
+          account && !ref_doc["account"]
         end
 
       end

data/lib/eco/api/common/version_patches/exception.rb

@@ -1,9 +1,16 @@
 class ::Exception
   def patch_full_message
-    msg = []
-    msg << "\n#{backtrace.first} \n#{message} (#{self.class.to_s})"
-    backtrace[1..-1].each_with_index {|bt, i| msg << "#{" "*8}#{i+1}: from #{bt}"}
-    msg.join("\n")
+    begin
+      msg = []
+      tracing   = backtrace ? backtrace : []
+      tracing   = (self.class == SystemStackError) ? tracing[1..30] : tracing[1..-1]
+      tracing ||= []
+      msg << "\n#{tracing.first} \n#{message} (#{self.class.to_s})"
+      tracing.each_with_index {|bt, i| msg << "#{" "*8}#{i+1}: from #{bt}"}
+      msg.join("\n")
+    rescue Exception => e
+      puts "Something is wrong with 'patch_full_message': #{e}"
+    end
   end
 end
 

data/lib/eco/api/microcases.rb

@@ -19,7 +19,9 @@ require_relative 'microcases/people_cache'
 require_relative 'microcases/people_load'
 require_relative 'microcases/people_refresh'
 require_relative 'microcases/people_search'
-require_relative 'microcases/refresh_abilities'
+require_relative 'microcases/preserve_filter_tags'
+require_relative 'microcases/preserve_default_tag'
+require_relative 'microcases/preserve_policy_groups'
 require_relative 'microcases/set_account'
 require_relative 'microcases/set_core_with_supervisor'
 require_relative 'microcases/set_core'

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

@@ -9,7 +9,6 @@ module Eco
         unless options.dig(:exclude, :account)
           if person.account
             person.account.policy_group_ids |= entry.policy_group_ids
-            micro.refresh_abilities(person, options)
           end
         end
       end

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

@@ -9,9 +9,9 @@ module Eco
 
         start = Time.now
         people = session.batch.get_people
-        secs    = Time.now - start
+        secs    = (Time.now - start).round(3)
         cnt     = people.count
-        per_sec = (cnt.to_f / secs).floor
+        per_sec = (cnt.to_f / secs).round(2)
         logger.info("Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)")
 
         file   = file_manager.save_json(people, filename, :timestamp)

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

@@ -34,9 +34,9 @@ module Eco
 
           start = Time.now
           session.batch.get_people.tap do |people|
-            secs    = Time.now - start
+            secs    = (Time.now - start).round(3)
             cnt     = people.count
-            per_sec = (cnt.to_f / secs).floor
+            per_sec = (cnt.to_f / secs).round(2)
             logger.info("Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)")
 
             if modifier.include?(:save) && people && people.length > 0

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

@@ -21,9 +21,9 @@ module Eco
 
         start = Time.now
         entries = session.batch.get_people(people, silent: true)
-        secs    = Time.now - start
+        secs    = (Time.now - start).round(3)
         cnt     = entries.count
-        per_sec = (cnt.to_f / secs).floor
+        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)")
 
         missing = people.length - entries.length

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

@@ -14,10 +14,10 @@ module Eco
 
         start = Time.now
         people = session.batch.search(data, silent: silent).yield_self do |status|
-          secs    = Time.now - start
+          secs    = (Time.now - start).round(3)
           Eco::API::Organization::People.new(status.people).tap do |people|
             cnt     = people.count
-            per_sec = (cnt.to_f / secs).floor
+            per_sec = (cnt.to_f / secs).round(2)
             msg     = "... could get #{cnt} people (out of #{data.length} entries) in #{secs} seconds (#{per_sec} people/sec)"
             session.logger.info(msg)
           end
@@ -29,10 +29,10 @@ module Eco
           session.logger.info("  Going to api get #{supers.length} current supervisors...")
           start = Time.now
           people = session.batch.search(supers, silent: silent).yield_self do |status|
-            secs    = Time.now - start
+            secs    = (Time.now - start).round(3)
             found   = status.people
             cnt     = found.count
-            per_sec = (cnt.to_f / secs).floor
+            per_sec = (cnt.to_f / secs).round(2)
             msg     = "... could find #{cnt} current supers (out of #{supers.length}) in #{secs} seconds (#{per_sec} people/sec)"
             session.logger.info(msg)
             people.merge(found, strict: micro.strict_search?(options))
@@ -46,10 +46,10 @@ module Eco
           start = Time.now
 
           people = session.batch.search(supers, silent: silent).yield_self do |status|
-            secs    = Time.now - start
+            secs    = (Time.now - start).round(3)
             found   = status.people
             cnt     = found.count
-            per_sec = (cnt.to_f / secs).floor
+            per_sec = (cnt.to_f / secs).round(2)
             msg     = "... could find #{cnt} input supers (out of #{supers.length}) in #{secs} seconds (#{per_sec} people/sec)"
             session.logger.info(msg)
             people.merge(found, strict: micro.strict_search?(options))

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

@@ -0,0 +1,23 @@
+module Eco
+  module API
+    class MicroCases
+      # Helper to preserve the original `default_tag`.
+      # @note
+      #   1. It only works if the original value of `default_tag` was **not** empty
+      # @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
+        end
+        person.account&.default_tag
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Eco
+  module API
+    class MicroCases
+      # Helper to preserve the original filter tags.
+      # @note
+      #   1. It only works if the original value of `filter_tags` was **not** empty
+      # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
+      # @param options [Hash] the options.
+      # @param keep_new [Boolean] tells if it should keep the new tags or get rid of them.
+      # @return [Array<String>] the final value of `filter_tags`.
+      def preserve_filter_tags(person, options, keep_new: false)
+        if person.as_update.key?("filter_tags")
+          if original  = person.original_doc["filter_tags"]
+            unless original.empty?
+              if keep_new
+                person.filter_tags += original
+              else
+                person.filter_tags  = original
+              end
+            end
+          end
+        end
+        person.filter_tags
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Eco
+  module API
+    class MicroCases
+      # Helper to preserve the original `policy_group_ids`.
+      # @note
+      #   1. It only works if the original value of `policy_group_ids` was **not** empty
+      # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
+      # @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
+          end
+        end
+        person.account&.policy_group_ids
+      end
+
+    end
+  end
+end

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

@@ -11,7 +11,6 @@ module Eco
           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)
-          micro.refresh_abilities(person, options)
         end
       end
 

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

@@ -12,16 +12,77 @@ module Eco
       # @yieldparam person [Ecoportal::API::V1::Person] the found person that matches `entry`, or a new person otherwise.
       # @return [Eco::API::Organization::People] all the people, including new and existing ones.
       def with_each(entries, people, options)
-        entries.map do |entry|
-          unless person = people.find(entry, strict: micro.strict_search?(options))
-            person = session.new_person
+        @_skip_all_multiple_results = false
+        entries.each_with_object([]) do |entry, scoped|
+          begin
+            unless person = people.find(entry, strict: micro.strict_search?(options))
+              person = session.new_person
+            end
+          rescue Eco::API::Organization::People::MultipleSearchResults => e
+            unless @_skip_all_multiple_results
+              msg    = "\n * When searching this Entry: #{entry.to_s(:identify)}"
+              person = _with_each_prompt_to_select_user(e.append_message(msg), entry: entry)
+            end
+          end
+
+          if person
+            person.entry = entry
+            yield(entry, person) if block_given?
+            scoped << person
           end
-          person.entry = entry
-          yield(entry, person) if block_given?
-          person
         end.yield_self {|all_people| people.newFrom all_people.uniq}
       end
 
+      private
+
+      def _with_each_prompt_to_select_user(error, entry: nil, increase_count: true)
+        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 << "\n(#{@_with_each_prompts}) " + error.to_s + "\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."
+        lines << "  (A)      - Ignore all the rest of input entries with this problem."
+        lines << "  (C)      - Create a new person."
+        lines << "  (B)      - Just break this script. I need to change the input file :/"
+
+        prompt_user("Type one option (#number/I/A/C/B):", explanation: lines.join("\n"), default: "I") do |res|
+          res = res.upcase
+          case
+          when res.start_with?("I")
+            logger.info "Ignoring entry... #{entry.to_s(:identify) if entry}"
+            nil
+          when res.start_with?("A")
+            logger.info "All input entries with this same issue will be ignored for this launch"
+            @_skip_all_multiple_results = true
+            nil
+          when res.start_with?("C")
+            logger.info "Creating new person...#{"for entry #{entry.to_s(:identify)}" if entry}"
+            session.new_person
+          when res.start_with?("B")
+            raise error
+          when res && !res.empty? && (pos = res.to_i rescue nil) && (pos < error.candidates.length)
+            error.candidate(pos).tap do |person|
+              logger.info "Thanks!! You selected #{person.identify}"
+              sleep(1.5)
+            end
+          else
+            if pos.is_a?(Numeric) && (pos >= error.candidates.length)
+              print "#{pos} is not a number in the range. "
+            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)
+          end
+        end
+      end
+
     end
   end
 end