eco-helpers 1.4.0 → 1.5.2

data/lib/eco/api/usecases/backup/create_details_case.rb

@@ -0,0 +1,31 @@
+module Eco
+  module API
+    class UseCases
+      class DefaultCases
+        class CreateDetailsCase < DefaultCase
+
+          def process
+            @cases.define("create-details", type: :sync) do |entries, people, session, options, usecase|
+              creation = session.job_group("main").new("create", usecase: usecase, type: :create, sets: [:core, :details])
+
+              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
+
+              entries.each.with_index do |entry, i|
+                if person = people.find(entry, strict: strict_search)
+                  session.logger.error("This person (id: '#{person.id}') already exists: #{entry.to_s(:identify)}")
+                else
+                  person = session.new_person
+                  entry.set_core(person, exclude: "supervisor_id")
+                  entry.set_details(person)
+
+                  creation.add(person)
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/usecases/backup/create_details_with_supervisor_case.rb

@@ -0,0 +1,48 @@
+module Eco
+  module API
+    class UseCases
+      class DefaultCases
+        class CreateDetailsWithSupervisorCase < DefaultCase
+
+          def process
+            # good candidate to do @cases.case("create-details").use.chain(@cases.case("set-supervisor").use)
+            @cases.define("create-details-with-supervisor", type: :sync) do |entries, people, session, options, usecase|
+              creation = session.job_group("main").new("create", usecase: usecase, type: :create, sets: [:core, :details])
+              supers   = session.job_group("post").new("supers", usecase: usecase, type: :update, sets: :core)
+
+              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
+
+              entries.each.with_index do |entry, i|
+                if person = people.find(entry, strict: strict_search)
+                  session.logger.error("This person (id: '#{person.id}') already exists: #{entry.to_s(:identify)}")
+                else
+                  person = session.new_person
+                  entry.set_core(person, exclude: "supervisor_id")
+                  entry.set_details(person)
+
+                  creation.add(person)
+
+                  # set supervisor
+                  if !(sup_id = entry.supervisor_id)
+                    person.supervisor_id = nil
+                  else
+                    if supervisor = people.person(id: sup_id, external_id: sup_id, email: sup_id)
+                      person.supervisor_id = supervisor.id
+                    else
+                      # delay setting supervisor if does not exit
+                      supers.add(person) do |person|
+                        person.supervisor_id = sup_id
+                      end
+                    end
+                  end
+
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/usecases/backup/hris_case.rb

@@ -0,0 +1,124 @@
+module Eco
+  module API
+    class UseCases
+      class DefaultCases
+        class HrisCase < DefaultCase
+
+          def process
+            @cases.define("hris", type: :sync) do |entries, people, session, options, usecase|
+              creation = session.job_group("main").new("create", usecase: usecase, type: :create, sets: [:core, :details, :account])
+              update   = session.job_group("main").new("update", usecase: usecase, type: :update, sets: [:core, :details, :account])
+              supers   = session.job_group("post").new("supers", usecase: usecase, type: :update, sets: :core)
+              leavers  = session.job_group("post").new("leavers", usecase: usecase, type: :update, sets: :account)
+
+              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
+              pgs           = session.policy_groups
+
+              people.each_with_index  do |person, i|
+                if !entries.find(person, strict: strict_search)
+                  leavers.add(person) do |person|
+                    person.supervisor_id = nil
+                    person.account       = nil if person.account
+                  end
+                end
+              end
+
+
+              if session.config.people.default_usergroup?
+                def_id  = pgs.to_id(session.config.people.default_usergroup)
+              end
+
+              entries.each_with_index do |entry, i|
+                person = people.find(entry, strict: strict_search)
+                person = session.new_person if create = !person
+
+                unless options.dig(:exclude, :core) && !create
+                  ini_tags   = person.filter_tags || []
+
+                  core_attrs = ["name", "external_id", "email", "filter_tags"]
+                  core_excluded = core_attrs.map.select {|attr| options.dig(:exclude, attr.to_sym)}
+                  core_excluded.push("supervisor_id")
+
+                  entry.set_core(person, exclude: core_excluded)
+                  if session.tagtree && !options.dig(:exclude, :filter_tags)
+                    person.filter_tags = session.tagtree.user_tags(
+                      initial:          ini_tags,
+                      final:            person.filter_tags,
+                      preserve_custom:  true,
+                      add_custom:       true
+                    )
+                  end
+                end
+
+                entry.set_details(person) unless options.dig(:exclude, :details)
+
+                unless options.dig(:exclude, :account)
+                  add_account = !person.account
+                  ini_pg_ids  = person.account&.policy_group_ids || []
+
+                  account_excluded = []
+                  account_excluded.push("policy_group_ids") if options.dig(:exclude, :policy_groups) && !create
+
+                  entry.set_account(person, exclude: account_excluded)
+
+                  person.account.send_invites = options[:send_invites] if options.key?(:send_invites)
+
+                  unless options.dig(:exclude, :policy_groups) && !create
+                    end_pg_ids = person.account.policy_group_ids || []
+
+                    if add_account && def_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_id]
+                    end
+
+                    # avoid false updates by preserving the original order
+                    person.account.policy_group_ids   = pgs.user_pg_ids(
+                      initial:         ini_pg_ids,
+                      final:           end_pg_ids
+                    )
+                  end
+
+                  person.account.permissions_custom = session.new_preset(person) unless !create && options.dig(:exclude, :abilities)
+
+                  unless options.dig(:exclude, :filter_tags) || 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
+
+                creation.add(person) if create
+                update.add(person) unless create
+
+                # set supervisor
+                unless options.dig(:exclude, :core) || options.dig(:exclude, :supervisor)
+                  if !(sup_id = entry.supervisor_id)
+                    person.supervisor_id = nil
+                  else
+                    if supervisor = people.person(id: sup_id, external_id: sup_id, email: sup_id)
+                      person.supervisor_id = supervisor.id
+                    else
+                      # delay setting supervisor if does not exit
+                      supers.add(person) do |person|
+                        person.supervisor_id = sup_id
+                      end
+                    end
+                  end
+                end
+
+              end
+
+            end
+
+
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/usecases/backup/set_default_tag_case.rb

@@ -0,0 +1,49 @@
+module Eco
+  module API
+    class UseCases
+      class DefaultCases
+        class SetDefaultTagCase < DefaultCase
+          # take the deepest tag (the one that is further down in the tree)
+          # different options (several nodes at the same depth):
+          # => take the common node between them (i.e. you have Hamilton and Auckland -> take New Zealand)
+          # => if there's no common node between them, take the `first` (unless they are at top level of the tree)
+
+          def process
+            @cases.define("set-default-tag", type: :transform) do |people, session, options, usecase|
+              if !session.tagtree
+                msg = "There is no tagtree definition in the configuration files\n" +
+                      "For this usecase to work out you need to define it."
+                session.logger.fatal(msg)
+                raise msg
+              end
+
+              # IMPORTANT: this two lines ensure that only people to be updated is selected
+              all_people = people
+              people = people.account_present
+
+              if people.length <= 0
+                msg = "There are no people with account... aborting script"
+                session.logger.info(msg)
+                raise msg
+              end
+
+              update   = session.job_group("main").new("update", usecase: usecase, type: :update, sets: :account)
+
+              people.each_with_index  do |person, i|
+                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
+                update.add(person)
+              end
+
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/usecases/backup/set_supervisor_case.rb

@@ -0,0 +1,41 @@
+module Eco
+  module API
+    class UseCases
+      class DefaultCases
+        class SetSupervisorCase < DefaultCase
+
+          def process
+            @cases.define("set-supervisor", type: :sync) do |entries, people, session, options, usecase|
+              job = session.job_group("main").new("update", usecase: usecase, type: :update, sets: :core)
+
+              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
+
+              entries.each.with_index do |entry, i|
+                person = people.find(entry, strict: strict_search)
+
+                if !person
+                  session.logger.error("This person does not exist: #{entry.to_s(:identify)}")
+                else
+                  sup_id = entry.supervisor_id
+                  supervisor = people.person(id: sup_id, external_id: sup_id, email: sup_id)
+
+                  if !supervisor
+                    if entry.supervisor_id
+                      msg = "Entry(#{i}) - supervisor id #{entry.supervisor_id} does not exist for person: #{entry.to_s(:identify)}"
+                      session.logger.warn(msg)
+                    end
+                  else
+                    # set internal id of the supervisor (detect if actually changed)
+                    person.supervisor_id = supervisor.id
+                    job.add(person)
+                  end
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/usecases/backup/transfer_account_case.rb

@@ -0,0 +1,90 @@
+module Eco
+  module API
+    class UseCases
+      class DefaultCases
+        class TransferAccountCase < DefaultCase
+
+          def process
+            @cases.define("transfer-account", type: :sync) do |entries, people, session, options, usecase|
+              remove_account = session.job_group("main").new("remove account", usecase: usecase, type: :update, sets: :account)
+              add_account    = session.job_group("post").new("add account", usecase: usecase, type: :update, sets: :account)
+
+              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
+
+              done = []; pending = []
+              pairs = entries.each_with_object([]) do |source|
+                entry_hash = source.internal_entry
+                unless entry_hash.key?("destination-id")
+                  session.logger.error("You haven't defined a column 'destination-id' to whom the account should be transferred")
+                  exit(1)
+                end
+                if peer_id = entry_hash["destination-id"]
+                  if peer = entries.entry(id: peer_id, external_id: peer_id)
+                    if done.include?(peer)
+                      session.logger.error("You paired '#{peer_id}' twice. A person can only receive account from 1 user")
+                      exit(1)
+                    end
+                    pending.delete(source)
+                    pending.delete(peer)
+                    done.push(source).push(pair)
+                    [source, peer]
+                  else
+                    pending.push(source)
+                    nil
+                  end
+                else
+                  pending.push(source)
+                end
+              end.compact
+
+              # Data input integrity check
+              unless pending.empty?
+                msg  = "You haven't defined a pair for the following ids:"
+                msg += pending.each_with_object("") do |entry, str|
+                  str << "\n#{entry.id || entry.external_id}"
+                end
+                session.logger.error(msg)
+                exit(1)
+              end
+
+              pairs.each do |pair|
+                src_entry, dst_entry = pair
+                unless src_person = people.find(src_entry, strict: strict_search)
+                  session.logger.error("This person does not exist: #{src_entry.to_s(:identify)}")
+                  exit(1)
+                end
+
+                unless dst_person = people.find(dst_entry,  strict: strict_search)
+                  session.logger.error("This person does not exist: #{dst_person.to_s(:identify)}")
+                  exit(1)
+                end
+
+                unless account_doc = src_person.account&.doc
+                  session.logger.error("You are trying to move account from a person that doesn't have: #{src_person.id | src_person.external_id}")
+                  exit(1)
+                end
+
+                if dst_person.email.to_s.strip.empty?
+                  session.logger.error("A person you are trying to add account doesn't have email: #{dst_person.id | dst_person.external_id}")
+                  exit(1)
+                end
+
+                src_person.account = nil
+                remove_account.add(src_person)
+                add_account.add(dst_person) do |person|
+                  # only if we got to remove the account of the original person
+                  if account_doc && src_person.as_update == {}
+                    person.account = account_doc
+                  end
+                end
+
+              end
+
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/usecases/backup/update_case.rb

@@ -0,0 +1,112 @@
+module Eco
+  module API
+    class UseCases
+      class DefaultCases
+        class UpdateCase < DefaultCase
+
+          def process
+            @cases.define("update", type: :sync) do |entries, people, session, options, usecase|
+              update   = session.job_group("main").new("update", usecase: usecase, type: :update, sets: [:core, :details, :account])
+              supers   = session.job_group("post").new("supers", usecase: usecase, type: :update, sets: :core)
+
+              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
+              pgs           = session.policy_groups
+
+              if session.config.people.default_usergroup?
+                def_id  = pgs.to_id(session.config.people.default_usergroup)
+              end
+
+              entries.each.with_index do |entry, i|
+                if person = people.find(entry, strict: strict_search)
+
+                  unless options.dig(:exclude, :core)
+                    ini_tags   = person.filter_tags || []
+
+                    core_attrs = ["name", "external_id", "email", "filter_tags"]
+                    core_excluded = core_attrs.map.select {|attr| options.dig(:exclude, attr.to_sym)}
+                    core_excluded.push("supervisor_id")
+
+                    entry.set_core(person, exclude: core_excluded)
+
+                    if session.tagtree && !options.dig(:exclude, :filter_tags)
+                      person.filter_tags = session.tagtree.user_tags(
+                        initial:          ini_tags,
+                        final:            person.filter_tags,
+                        preserve_custom:  true,
+                        add_custom:       true
+                      )
+                    end
+                  end
+
+                  entry.set_details(person) unless options.dig(:exclude, :details)
+
+                  unless options.dig(:exclude, :account)
+                    add_account = !person.account
+                    ini_pg_ids = person.account&.policy_group_ids || []
+
+                    account_excluded = []
+                    account_excluded.push("policy_group_ids") if options.dig(:exclude, :policy_groups)
+
+                    entry.set_account(person, exclude: account_excluded)
+
+                    person.account.send_invites = options[:send_invites] if options.key?(:send_invites)
+
+                    unless options.dig(:exclude, :policy_groups) && !create
+                      end_pg_ids = person.account.policy_group_ids || []
+
+                      if add_account && def_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_id]
+                      end
+
+                      # avoid false updates by preserving the original order
+                      person.account.policy_group_ids   = pgs.user_pg_ids(
+                        initial:         ini_pg_ids,
+                        final:           end_pg_ids
+                      )
+                    end
+
+                    person.account.permissions_custom = session.new_preset(person) unless options.dig(:exclude, :abilities)
+
+                    unless options.dig(:exclude, :filter_tags) || 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
+                  update.add(person)
+
+                  # set supervisor
+                  unless options.dig(:exclude, :core) || options.dig(:exclude, :supervisor)
+                    if !(sup_id = entry.supervisor_id)
+                      person.supervisor_id = nil
+                    else
+                      if supervisor = people.person(id: sup_id, external_id: sup_id, email: sup_id)
+                        person.supervisor_id = supervisor.id
+                      else
+                        # delay setting supervisor if does not exit
+                        supers.add(person) do |person|
+                          person.supervisor_id = sup_id
+                        end
+                      end
+                    end
+                  end
+
+                else
+                  session.logger.error("This person does not exist: #{entry.to_s(:identify)}")
+                end
+              end
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end