eco-helpers 2.0.49 → 2.0.52

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b4a2ad99ea2e78519b611cdcdb74743ae9dd1a8f5707164ebcc686c21d83700
-  data.tar.gz: b9387499878102825b1396bf35394cc12c35c4b738380f3bfd52e2407c4239af
+  metadata.gz: c6424664c072321d2d1c45388fea06cfe16e8e42f4949e202be31555e8e052fa
+  data.tar.gz: 7b18ae74a24157949fbb80b26320b31312ef91c43eb73f1384c8c964da52e79c
 SHA512:
-  metadata.gz: d574a346ba439207b85cfd1e265ed4b3c3f3742dd6308adfc8a873717bea8fd0f9ceaec49fcde1ea5575068c4e00395a4a200b42d624b45e707bd89d68b4560a
-  data.tar.gz: 99a77ede34b322d1ebe6ad54822db841ae111e7063a4dbd6317dd092222a43919e8e059536db9f9c386bbbc31cd8043e64192f425a4fae055f3511ae6f622e67
+  metadata.gz: 6d1e57dc41b76a01bc80cf08108b4e50a456976dbe05bb33a4620cccb2ae745c76e88ce5af0c43795171ac758f6f55465835e22373a484967dd5a4f3ed57e318
+  data.tar.gz: 901007d2346ef608b67011e6f49f560c16a5cb6f0010b16fa24441bf2cfd06a8f8aa82dfd4ba78b86e50cd0aca340047173f6e80800f56340dad668bb27f1516

data/CHANGELOG.md

@@ -1,15 +1,41 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.0.52] - 2022-02-xx
+
+### Added
+  - `Eco::API::UseCases::DefaultCases::CleanUnknownTags` include `default_tag` refresh
+  
+### Changed
+### Fixed
+  - `Eco::Data::Files::Directory#dir_files` to be returned in alphabetic order
+
+## [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
+
+## [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
 
-### Changed
-### Fixed
-
 ## [2.0.48] - 2022-02-04
 
 ### Changed

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/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/clean_unknown_tags_case.rb

@@ -23,6 +23,12 @@ class Eco::API::UseCases::DefaultCases::CleanUnknownTags < Eco::API::Common::Loa
       unknown_tags = person.filter_tags.select {|tag| !tag?(tag)}
       person.filter_tags -= unknown_tags
       unknown_tag!(*unknown_tags)
+      if (account = person.account) && tag = account.default_tag
+        unless tag?(tag)
+          micro.refresh_default_tag(person.entry, person, options)
+          unknown_tag!(tag)
+        end
+      end
       update.add(person)
     end
   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.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")

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/data/files/directory.rb

@@ -53,7 +53,7 @@ module Eco
 
         def dir_files(file: nil, pattern: dir_pattern)
           find = !!file ? file_pattern(file) : file_pattern(pattern)
-          Dir.glob(find)
+          Dir.glob(find).sort
         end
 
         def newest_file(files_list = nil, file: nil)

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.49"
+  VERSION = "2.0.52"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.49
+  version: 2.0.52
 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