eco-helpers 2.0.48 → 2.0.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39d2573c1aecfe5839a1867d549ae47af247cbb7819f4733a8c0a07ff98d9e65
-  data.tar.gz: c2318e2dd890bdf4a973332c6849c271bb8593c3f799c2add8b34064b022d54e
+  metadata.gz: fb5e3755230835f1a3ad402b7dd2fc9b25902ea2ca3a621c8eae0229de716791
+  data.tar.gz: c0af346142ec3ff97c32503597ae36d9844273e1c20fb6908a3cfcf5595dff54
 SHA512:
-  metadata.gz: 9319378014f0c596dfd3f458e2fe8f3852906c22bf04234f29c5bc28d3e2b677f1e801310d37fcb4505e555b1b258e5ba2a0c0a46c2ac5b7c32c96e274fda45a
-  data.tar.gz: 61cfb4fe7e2a7d125e3cc3c0c25175bd732fe048654e7b11044c4b897414d51253ab16f7b97d8178d4ec6167d4e216ec13af7666efc72fb278d332d5a6723c27
+  metadata.gz: 4a2f508415dac83ffe596e330d56a55eb427788d57d239b62b1523bb6abb8f465d6400c1f0c61135d7eb6e036a595d7aacb158cc464e9840a5af8ac56d3582af
+  data.tar.gz: b791358e41d4aa2db17b5fcd68e0e2aa97af7b4c31d21d9308132e470f07a67c638b53085846006363e2d9d962dba9b5250a9afe358844b113ac4a7c73a4df53

data/CHANGELOG.md

@@ -1,9 +1,37 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.48] - 2022-02-xx
+## [2.0.51] - 2022-02-27
 
 ### Added
+  - `Eco::API::MicroCases#person_update!` launches an update against the Server for one person
+  - `Eco::API::MicroCases#take_email_from_account` with given an account associated to an `email` that we cannot take, it associates that account to a different email
+
+### Changed
+### Fixed
+
+## [2.0.50] - 2022-02-23
+
+### Added
+  - Ability to configure delay between jobs and job groups
+    - `Eco::API::Session::Batch::Jobs`, `#delay_between_jobs`
+    - `Eco::API::Session::Batch::JobsGroups`, `#delay_between_groups`
+    - `Eco::API::Session::Config`, added methods `#delay_between_jobs` and `#delay_between_job_groups`
+  - New use case `Eco::API::UseCases::DefaultCases::TagPaths` to create a `csv` with all `tag` paths
+    - Its purpose is to ease the build of tag remaps
+    - Ideally, after remapping the tags of an org, you would want to fix the tag paths based on the current tagtree
+
+### Changed
+  - `workflow`, when no operation specified it logs as `info`, rather than `warn`
+
+## [2.0.49] - 2022-02-14
+
+### Added
+  - `Eco::API::Session::Batch::RequestStats#message` now it shows which details have changed
+  - `Eco::API::UseCases::DefaultCases::ReinviteTransCase` the option `-force` will also send an invite to users that have accepted the invitation
+
+## [2.0.48] - 2022-02-04
+
 ### Changed
   - upgraded `ecoportal-api-v2` dependency
 

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

@@ -0,0 +1,39 @@
+module Eco
+  module API
+    class MicroCases
+      # It updates an idividual person.
+      # @note if it succeeds the update, it calls `person.consolidate!`
+      # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
+      # @param context [String] main part of the message.
+      # @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)
+          if response.success?
+            person.consolidate!
+            true
+          else
+            msg  = "#{context} Error #{response.status}: #{response.body}\n"
+            msg += " -- Failed to \"#{reason}\".\n"
+            msg += "  • Person: #{person_ref(person)}"
+            logger.error(msg)
+            false
+          end
+        else
+          msg  = "#{context} Error (connection error)\n"
+          msg += " -- Failed to \"#{reason}\".\n"
+          msg += "  • Person: #{person_ref(person)}"
+          logger.error(msg)
+          false
+        end
+      end
+
+      private
+
+      def person_ref(person)
+        Eco::API::Session::Batch::Feedback.person_ref(person)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+module Eco
+  module API
+    class MicroCases
+      # Frees up `target_email` from an account not present in this org.
+      #   Allows to force `target_email` on the current user's account.
+      #   - If the person does not have account, this case will not do anything.
+      #   - 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.
+      #   - 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 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"]`.
+      # @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"]
+
+        target_email  ||= person.email
+        account_email   = person.original_doc["email"]
+
+        return false unless target_email != account_email
+        return false if account_email.to_s.strip.empty?
+        return false if target_email.to_s.strip.empty?
+
+        if dest_email.is_a?(String)
+          return false unless target_email != dest_email
+          return false unless dest_email   != account_email
+          return false if dest_email.to_s.strip.empty?
+        end
+
+        account_json  = JSON.parse(account.to_json)
+        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_acquire_account!(person, account_email, account: account_json, context: context)
+                  person.email = target_email
+                end
+              end
+            else # free up target email
+              # restore
+              if _take_email_remove_account!(person, context: context)
+                _take_email_acquire_account!(person, account_email, account: account_json, context: context)
+              end
+              success = false
+            end
+          else # aquire other account
+            # restore
+            _take_email_acquire_account!(person, account_email, account: account_json, context: context)
+            success = false
+          end
+        end
+        success
+      end
+
+      private
+
+      def _take_email_acquire_account!(person, target_email, account: {}, context: "Session")
+        person.account = account
+        person.account.send_invites = false
+        person.email   = target_email
+        micro.person_update!(person, reason: "bring account with email '#{target_email}'", context: context)
+      end
+
+      def _take_email_email_free_up!(person, dest_email:, target_email: nil, context: "Session")
+        target_email ||= person.email
+        person.email   = dest_email.is_a?(Proc)? dest_email.call(target_email) : dest_email
+        reason = "free up email '#{target_email}', by moving account to '#{person.email}'"
+        micro.person_update!(person, reason: reason, context: context)
+      end
+
+      def _take_email_remove_account!(person, context: "Session")
+        person.account = nil
+        micro.person_update!(person, reason: "remove account", context: context)
+      end
+
+    end
+  end
+end

data/lib/eco/api/microcases.rb

@@ -19,6 +19,7 @@ require_relative 'microcases/people_cache'
 require_relative 'microcases/people_load'
 require_relative 'microcases/people_refresh'
 require_relative 'microcases/people_search'
+require_relative 'microcases/person_update'
 require_relative 'microcases/preserve_filter_tags'
 require_relative 'microcases/preserve_default_tag'
 require_relative 'microcases/preserve_policy_groups'
@@ -26,9 +27,10 @@ require_relative 'microcases/set_account'
 require_relative 'microcases/set_core_with_supervisor'
 require_relative 'microcases/set_core'
 require_relative 'microcases/refresh_default_tag'
+require_relative 'microcases/s3upload_targets'
 require_relative 'microcases/set_supervisor'
 require_relative 'microcases/strict_search'
-require_relative 'microcases/s3upload_targets'
+require_relative 'microcases/take_email_from_account'
 require_relative 'microcases/with_each'
 require_relative 'microcases/with_each_leaver'
 require_relative 'microcases/with_each_present'

data/lib/eco/api/session/batch/jobs.rb

@@ -3,6 +3,8 @@ module Eco
     class Session
       class Batch
         class Jobs < API::Common::Session::BaseSession
+          DELAY_BETWEEN_JOBS = 0.3
+
           include Enumerable
           attr_reader :name
 
@@ -87,11 +89,12 @@ module Eco
           #   - if there was post-launch callback for a `Batch::Job`, it calls it.
           # @return [Hash<Eco::API::Session::Batch::Job, Eco::API::Session::Batch::Status>]
           def launch(simulate: false)
-            each do |job|
+            each_with_index do |job, idx|
               if job.pending?
                 status[job] = job_status = job.launch(simulate: simulate)
                 callback    = @callbacks[job]
                 callback.call(job, job_status) if callback
+                Eco::API::Session::Batch::JobsGroups.counter(delay_between_jobs) if !simulate && idx < self.length - 1
               end
             end
             launch(simulate: simulate) if pending?
@@ -125,6 +128,11 @@ module Eco
             end.join("\n")
           end
 
+          private
+
+          def delay_between_jobs
+            config.delay_between_jobs || DELAY_BETWEEN_JOBS
+          end
         end
       end
     end

data/lib/eco/api/session/batch/jobs_groups.rb

@@ -93,10 +93,10 @@ module Eco
                 status[group] = group_status = group.launch(simulate: simulate)
                 callback = @callbacks[group]
                 callback.call(group, group_status) if callback
-                self.class.counter(DELAY_BETWEEN_GROUPS) if !simulate && idx < @order.length - 1
+                self.class.counter(delay_between_groups) if !simulate && idx < @order.length - 1
               end
             end
-            launch(simulate: simulate) if pending?            
+            launch(simulate: simulate) if pending?
             return status
           end
 
@@ -127,6 +127,11 @@ module Eco
             end.join("\n")
           end
 
+          private
+
+          def delay_between_groups
+            config.delay_between_job_groups || DELAY_BETWEEN_GROUPS
+          end
         end
       end
     end

data/lib/eco/api/session/batch/request_stats.rb

@@ -9,6 +9,7 @@ module Eco
           ACCOUNT_ATTRS  = (Eco::API::Common::People::PersonParser::ACCOUNT_ATTRS + ["permissions_custom"]).uniq
           DETAILS_ATTRS  = ["fields"]
           BLANKED_PREFIX = "blanked_"
+          DETAILS_FIELDS = "details_fields"
 
           class << self
 
@@ -74,44 +75,43 @@ module Eco
           end
 
           def message(percent: false)
-            key_val_delimiter = ": "; attr_delimiter = " ++ "
-            pairs_to_line = Proc.new do |pairs|
-              pairs.map do |p|
-                [p.first.to_s, "#{p.last.to_s}" + (percent ? "%" : "")].join(key_val_delimiter)
-              end.join(attr_delimiter)
-            end
-
             lines = []
-            lines << pairs_to_line.call(core_pairs(percent: percent))
-            lines << pairs_to_line.call(account_pairs(percent: percent))
-            lines << pairs_to_line.call(details_pairs(percent: percent))
+            lines << pairs_to_line(core_pairs(percent: percent))
+            lines << pairs_to_line(account_pairs(percent: percent))
+            lines << pairs_to_line(details_pairs(percent: percent))
             lines.join("\n")
           end
 
           private
 
-          def attr(attr, percent: false, total: count)
-            i = @stats["#{attr}"]
+          def attr_value(attr, percent: false, total: count, details: false)
+            target = details ? (@stats[DETAILS_FIELDS] || {}) : @stats
+            i = target["#{attr}"]
             return i unless percent
             percentage(i, total: total)
           end
 
           def core(percent: false)
-            attr("core", percent: percent)
+            attr_value("core", percent: percent)
           end
 
           def account(percent: false)
-            attr("account", percent: percent)
+            attr_value("account", percent: percent)
           end
 
           def details(percent: false)
-            attr("details", percent: percent)
+            attr_value("details", percent: percent)
+          end
+
+          def stats
+            @stats ||= Hash.new(0)
           end
 
           def build(requests)
-            Hash.new(0).tap do |stats|
+            stats.tap do |stats|
               stats[type] = count
               unless !requests || !requests.is_a?(Enumerable) || requests.empty?
+                stats[DETAILS_FIELDS] = Hash.new(0)
                 requests.each_with_index do |request|
                   add_core_stats(stats, request || {})
                   add_account_stats(stats, request || {})
@@ -149,16 +149,15 @@ module Eco
             if request.key?("details")
               stats["details"] += 1
               stats["details_remove"] += 1 if !request["details"]
+
+              det_attrs = {}
               if fields = request.dig("details", "fields")
                 stats["fields"] += fields.length
+                det_attrs = fields.each_with_object(det_attrs) {|fld, hash| hash[fld["alt_id"]] = fld["value"]}
               end
-            end
-          end
 
-          def pairs(attrs, percent: false, total: count)
-            pairs = attrs.map do |a|
-              (v = attr(a, percent: percent, total: count)) > 0 ? [a, v] : nil
-            end.compact
+              attrs_to_stat(stats[DETAILS_FIELDS], det_attrs, det_attrs.keys)
+            end
           end
 
           def core_pairs(percent: false)
@@ -172,22 +171,23 @@ module Eco
           end
 
           def details_pairs(percent: false)
-            details_pairs  = [["details", details(percent: percent)]]
-            details_pairs += [["fields", fields_average]] if attr("fields") && fields_average
-            details_pairs += pairs(["details_remove"], percent: percent, total: details)
+            det_pairs  = [["details", details(percent: percent)]]
+            det_pairs += [["fields", fields_average]] if attr_value("fields") && fields_average
+            det_pairs += pairs(["details_remove"], percent: percent, total: details)
+            det_pairs += pairs(details_field_attrs, percent: percent, total: details, details: true)
           end
 
-          def fields_average
-            if (fields_num = attr("fields")) && (total = details) > 0
-              (fields_num.to_f / total.to_f).round(2)
-            end
+          def pairs(attrs, percent: false, total: count, details: false)
+            pairs = attrs.map do |a|
+              (v = attr_value(a, percent: percent, total: count, details: details)) > 0 ? [a, v] : nil
+            end.compact
           end
 
-          def percentage(num, total: count)
-            total ||= count
-            if num
-              (num.to_f / total * 100).round(2)
-            end
+          def pairs_to_line(pairs, percent: false)
+            key_val_delimiter = ": "; attr_delimiter = " ++ "
+            pairs.map do |p|
+              [p.first.to_s, "#{p.last.to_s}" + (percent ? "%" : "")].join(key_val_delimiter)
+            end.join(attr_delimiter)
           end
 
           def core_attrs
@@ -202,6 +202,10 @@ module Eco
             @details_attrs ||= self.class.details_attrs
           end
 
+          def details_field_attrs
+            @stats[DETAILS_FIELDS].keys
+          end
+
           def blank_attrs(attrs)
             self.class.blank_attrs(attrs)
           end
@@ -225,6 +229,18 @@ module Eco
             end
           end
 
+          def fields_average
+            if (fields_num = attr_value("fields")) && (total = details) > 0
+              (fields_num.to_f / total.to_f).round(2)
+            end
+          end
+
+          def percentage(num, total: count)
+            total ||= count
+            if num
+              (num.to_f / total * 100).round(2)
+            end
+          end
         end
       end
     end

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

@@ -363,6 +363,18 @@ module Eco
             yield(wf) if block_given?
           end
         end
+
+        # @return [nil, Interger] seconds between jobs
+        def delay_between_jobs(seconds = nil)
+          self["delay_between_jobs"] = seconds if seconds
+          self["delay_between_jobs"]
+        end
+
+        # @return [nil, Interger] seconds between job groups
+        def delay_between_job_groups(seconds = nil)
+          self["delay_between_job_groups"] = seconds if seconds
+          self["delay_between_job_groups"]
+        end
         # @!endgroup
 
       end

data/lib/eco/api/usecases/default_cases/create_tag_paths_case.rb

@@ -0,0 +1,25 @@
+class Eco::API::UseCases::DefaultCases::TagPaths < Eco::API::Common::Loaders::UseCase
+  name "create-tag-paths"
+  type :other
+
+  def main(session, options, usecase)
+    CSV.open("tag_paths.csv", "w") do |csv|
+      csv << ["Tag", "Path"]
+      tag_paths.each do |values|
+        csv << values
+      end
+    end
+  end
+
+  private
+
+  def tag_paths
+    @tag_paths ||= tagtree.tags.map do |tag|
+      [tag, tagtree.path(tag).join("|")]
+    end
+  end
+
+  def tagtree
+    session.tagtree
+  end
+end

data/lib/eco/api/usecases/default_cases/reinvite_trans_case.rb

@@ -2,16 +2,25 @@ class Eco::API::UseCases::DefaultCases::ReinviteTransCase < Eco::API::Common::Lo
   name "reinvite"
   type :transform
 
+  def main(people, session, options, usecase)
+    reinvite(people.users, session, options, usecase)
+  end
+
+  private
+
   def reinvite(users, session, options, usecase)
     invite   = session.new_job("main", "invite", :update, usecase, :account)
     users.each do |person|
-      person.account.send_invites = true
+      if force_invite?
+        person.account.send_invites = true
+      else
+        person.account.force_send_invites = true
+      end
       invite.add(person)
     end
   end
 
-  def main(people, session, options, usecase)
-    reinvite(people.users, session, options, usecase)
+  def force_invite?
+    options.dig(:force, :invite)
   end
-
 end

data/lib/eco/api/usecases/default_cases/samples/sftp_case.rb

@@ -28,7 +28,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
 
   # Ex: "/IN/Personnel"
   def remote_subfolder
-    raise "You should redefine remote_subfolder as the folder where the target file sits"
+    raise "You should redefine remote_subfolder as the folder where the target file sits. Ex: /IN/Personnel"
   end
 
   def archive_subfolder

data/lib/eco/api/usecases/default_cases.rb

@@ -19,6 +19,7 @@ require_relative 'default_cases/codes_to_tags_case'
 require_relative 'default_cases/create_case'
 require_relative 'default_cases/create_details_case'
 require_relative 'default_cases/create_details_with_supervisor_case'
+require_relative 'default_cases/create_tag_paths_case'
 require_relative 'default_cases/delete_trans_case'
 require_relative 'default_cases/delete_sync_case'
 require_relative 'default_cases/email_as_id_case'

data/lib/eco/cli/config/default/usecases.rb

@@ -87,6 +87,9 @@ ASSETS.cli.config do |cnf|
       options.deep_merge!(other: {file: {codes_column: col_codes}})
     end
 
+    desc = "Creates a CSV with the paths to each tag"
+    cases.add("-create-tag-paths", :other, desc, case_name: "create-tag-paths")
+
     desc  = "Cleans from filter_tags those tags that are not present in the tagtree (as per tagtree.json file)."
     desc += " It will preserve standard register tags of most common registers (i.e. EVENT, RISK)."
     cases.add("-clean-unknown-tags", :transform, desc, case_name: "clean-unknown-tags")
@@ -183,9 +186,15 @@ ASSETS.cli.config do |cnf|
 
     desc = "Re-sends invites to all filtered users that have not accepted the invite as yet"
     cases.add("-reinvite", :transform, desc, case_name: "reinvite")
+    .add_option("-force", "If also send an invite email to those that have accepted the invite") do |options|
+      options.deep_merge!(force: {invite: true})
+    end
 
     desc = "Re-sends invites to target users that have not accepted the invite as yet"
     cases.add("-reinvite-from", :sync, desc, case_name: "reinvite")
+    .add_option("-force", "If also send an invite email to those that have accepted the invite") do |options|
+      options.deep_merge!(force: {invite: true})
+    end
 
     desc = "Deletes everybody that has been filtered from the people manager"
     cases.add("-delete", :transform, desc, case_name: "delete")

data/lib/eco/cli/config/default/workflow.rb

@@ -80,7 +80,7 @@ ASSETS.cli.config do |config|
     wf.on(:usecases) do |wf_cases, io|
       unless config.usecases.process(io: io)
         msg = "No update operation specified... quitting"
-        io.session.logger.warn(msg)
+        io.session.logger.info(msg)
         exit(1)
       end
       io

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.48"
+  VERSION = "2.0.51"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.48
+  version: 2.0.51
 platform: ruby
 authors:
 - Oscar Segura
@@ -462,6 +462,7 @@ files:
 - lib/eco/api/microcases/people_load.rb
 - lib/eco/api/microcases/people_refresh.rb
 - lib/eco/api/microcases/people_search.rb
+- lib/eco/api/microcases/person_update.rb
 - lib/eco/api/microcases/preserve_default_tag.rb
 - lib/eco/api/microcases/preserve_filter_tags.rb
 - lib/eco/api/microcases/preserve_policy_groups.rb
@@ -472,6 +473,7 @@ files:
 - lib/eco/api/microcases/set_core_with_supervisor.rb
 - lib/eco/api/microcases/set_supervisor.rb
 - lib/eco/api/microcases/strict_search.rb
+- lib/eco/api/microcases/take_email_from_account.rb
 - lib/eco/api/microcases/with_each.rb
 - lib/eco/api/microcases/with_each_leaver.rb
 - lib/eco/api/microcases/with_each_present.rb
@@ -530,6 +532,7 @@ files:
 - lib/eco/api/usecases/default_cases/create_case.rb
 - lib/eco/api/usecases/default_cases/create_details_case.rb
 - lib/eco/api/usecases/default_cases/create_details_with_supervisor_case.rb
+- lib/eco/api/usecases/default_cases/create_tag_paths_case.rb
 - lib/eco/api/usecases/default_cases/delete_sync_case.rb
 - lib/eco/api/usecases/default_cases/delete_trans_case.rb
 - lib/eco/api/usecases/default_cases/email_as_id_case.rb