eco-helpers 1.5.9 → 1.5.14

data/lib/eco/api/session.rb

@@ -187,6 +187,8 @@ module Eco
       end
 
       # Does merge `Eco::API::UseCases::DefaultCases` with the custom cases.
+      # @note
+      #   - the order matters, as a default usecase can be redefined by a custom one with same name
       # @return [Eco::API::UseCases]
       def usecases
         @usecases ||= config.usecases.dup.tap do |cases|
@@ -195,6 +197,17 @@ module Eco
         end
       end
 
+      # Does merge `Eco::API::Policies::DefaultPolicies` with the custom policies.
+      # @note
+      #   - the default policies are added at the end (meaning they will run after the custom policies)
+      # @return [Eco::API::Policies]
+      def policies
+        @policies ||= config.policies.dup.tap do |policies|
+          default_policies = Eco::API::Policies::DefaultPolicies.new
+          policies.merge(default_policies)
+        end
+      end
+
       # Set of helpers to simplify your code
       # @see Eco::API::MicroCases
       # @return [Eco::API::MicroCases]

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

@@ -123,7 +123,7 @@ module Eco
               entry    = queue.to_a[i]
               response = status[i]
               msg      = "Error #{response.status}: #{response.body}\n"
-              msg     += "-- Failed to batch #{method} (entry #{i+1}). Person: #{person_ref(entry)}"
+              msg     += "-- Failed to batch #{method}. Person: #{person_ref(entry)}"
             end
             msg
           end
@@ -164,7 +164,8 @@ module Eco
           private
 
           def person_ref(entry)
-            "(id: '#{get_attr(entry, :id)}') '#{get_attr(entry, :name)}' ('#{get_attr(entry, :external_id)}': '#{get_attr(entry, :email)}')"
+            row_str = (row = get_row(entry)) ? "(row: #{row}) " : nil
+            "#{row_str}(id: '#{get_attr(entry, :id)}') '#{get_attr(entry, :name)}' ('#{get_attr(entry, :external_id)}': '#{get_attr(entry, :email)}')"
           end
 
           def get_attr(entry, attr)
@@ -175,6 +176,15 @@ module Eco
             end
           end
 
+          def get_row(value)
+            case value
+            when Eco::API::Common::People::PersonEntry
+              value.idx
+            when Ecoportal::API::V1::Person
+              get_row(value.entry)
+            end
+          end
+
         end
       end
     end

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

@@ -71,12 +71,6 @@ module Eco
             @subjobs ||= Eco::API::Session::Batch::Jobs.new(enviro, name: "childs-of:#{self.name}")
           end
 
-          def subjobs_add(name = "ad-hoc:job-from:#{self.name}", usecase: self.usecase, &block)
-            dup(name, usecase: usecase).tap do |subjob|
-              subjobs.add(subjob, &block)
-            end
-          end
-
           # @return [Boolean] `true` if the current batch job is a result of an error_handler
           def error_handler?
             usecase? && usecase.is_a?(Eco::API::Error::Handler)
@@ -211,6 +205,7 @@ module Eco
                 end
 
                 msg << status.errors.message unless !status
+                msg << subjobs_summary
               end
             end.join("\n")
           end
@@ -238,7 +233,7 @@ module Eco
           # Applies the changes introduced by api policies
           def apply_policies(pre_queue)
             people(pre_queue).tap do |entries|
-              policies = session.config.policies
+              policies = session.policies
               unless policies.empty? || options.dig(:skip, :api_policies)
                 policies.launch(people: entries, session: session, options: options, job: self)
               end
@@ -307,6 +302,21 @@ module Eco
             file_manager.save_json(requests, file, :timestamp)
           end
 
+          # Adds a job tied to the current job
+          # Used with error handlers that need their own job to run
+          def subjobs_add(name = "ad-hoc:job-from:#{self.name}", usecase: self.usecase, &block)
+            dup(name, usecase: usecase).tap do |subjob|
+              subjobs.add(subjob, &block)
+            end
+          end
+
+          def subjobs_summary
+            return "" unless subjobs.count > 0
+            [].tap do |msg|
+              subjobs.map {|subjob| msg << subjob.summary}
+            end.join("\n")
+          end
+
         end
       end
     end

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

@@ -142,7 +142,7 @@ module Eco
             when :v1
               klass.new(external_key, host: host, logger: logger)
             when :v2
-              klass.new(user_key: user_key, org_key: external_key, logger: logger)
+              klass.new(user_key: user_key, org_key: external_key, host: host, logger: logger)
             end.tap do |api|
               unless !api || log_connection?
                 @logger.info("Created api#{self.version(version)} connection on '#{name}' enviro, pointing to '#{host}' in '#{mode}' mode")

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "1.5.9"
+  VERSION = "1.5.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.5.14
 platform: ruby
 authors:
 - Oscar Segura
@@ -116,7 +116,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 0.7.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
@@ -126,7 +126,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 0.7.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.7.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.7.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
@@ -286,6 +286,8 @@ files:
 - lib/eco/api/common/session/environment.rb
 - lib/eco/api/common/session/file_manager.rb
 - lib/eco/api/common/session/logger.rb
+- lib/eco/api/common/session/logger/cache.rb
+- lib/eco/api/common/session/logger/log.rb
 - lib/eco/api/common/session/mailer.rb
 - lib/eco/api/common/session/s3_uploader.rb
 - lib/eco/api/common/session/sftp.rb
@@ -342,6 +344,8 @@ files:
 - lib/eco/api/organization/presets_values.json
 - lib/eco/api/organization/tag_tree.rb
 - lib/eco/api/policies.rb
+- lib/eco/api/policies/default_policies.rb
+- lib/eco/api/policies/default_policies/99_user_access_policy.rb
 - lib/eco/api/policies/policy.rb
 - lib/eco/api/session.rb
 - lib/eco/api/session/batch.rb
@@ -367,17 +371,6 @@ files:
 - lib/eco/api/session/config/sftp.rb
 - lib/eco/api/session/config/workflow.rb
 - lib/eco/api/usecases.rb
-- lib/eco/api/usecases/backup/append_usergroups_case.rb
-- lib/eco/api/usecases/backup/create_case.rb
-- lib/eco/api/usecases/backup/create_details_case.rb
-- lib/eco/api/usecases/backup/create_details_with_supervisor_case.rb
-- lib/eco/api/usecases/backup/hris_case.rb
-- lib/eco/api/usecases/backup/set_default_tag_case.rb
-- lib/eco/api/usecases/backup/set_supervisor_case.rb
-- lib/eco/api/usecases/backup/transfer_account_case.rb
-- lib/eco/api/usecases/backup/update_case.rb
-- lib/eco/api/usecases/backup/update_details_case.rb
-- lib/eco/api/usecases/backup/upsert_case.rb
 - lib/eco/api/usecases/base_case.rb
 - lib/eco/api/usecases/base_io.rb
 - lib/eco/api/usecases/default_cases.rb
@@ -474,7 +467,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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

@@ -1,36 +0,0 @@
-module Eco
-  module API
-    class UseCases
-      class DefaultCases
-        class AppendUsergroupsCase < DefaultCase
-
-          def process
-            @cases.define("append-usergroups", type: :sync) do |entries, people, session, options, usecase|
-              update   = session.job_group("main").new("update", usecase: usecase, type: :update, sets: [:core, :details, :account])
-
-              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
-              pgs = session.policy_groups
-
-              entries.each.with_index do |entry, i|
-                if person = people.find(entry, strict: strict_search)
-                  if person.account
-                    ini_pg_ids = person.account&.policy_group_ids || []
-                    add        = entry.internal_entry["policy_group_ids"].to_s.split("|").compact
-                    person.account.policy_group_ids = (ini_pg_ids | add).uniq
-
-                    person.account.permissions_custom = session.new_preset(person) unless options.dig(:exclude, :abilities)
-                    update.add(person)
-                  end
-                else
-                  session.logger.error("This person does not exist: #{entry.to_s(:identify)}")
-                end
-              end
-            end
-
-          end
-
-        end
-      end
-    end
-  end
-end

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

@@ -1,104 +0,0 @@
-module Eco
-  module API
-    class UseCases
-      class DefaultCases
-        class CreateCase < DefaultCase
-
-          def process
-            @cases.define("create", type: :sync) do |entries, people, session, options, usecase|
-              creation = session.job_group("main").new("create", usecase: usecase, type: :create, 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)
-                  session.logger.error("This person (id: '#{person.id}') already exists: #{entry.to_s(:identify)}")
-                else
-                  person = session.new_person
-                  core_excluded = ["supervisor_id"]
-
-                  ini_tags   = person.filter_tags || []
-                  entry.set_core(person, exclude: core_excluded)
-
-                  if session.tagtree
-                    person.filter_tags = session.tagtree.user_tags(
-                      initial:          ini_tags,
-                      final:            person.filter_tags,
-                      preserve_custom:  true,
-                      add_custom:       true
-                    )
-                  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)
-
-                    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
-
-                  creation.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
-
-                end
-              end
-            end
-          end
-
-        end
-      end
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-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

@@ -1,48 +0,0 @@
-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

@@ -1,124 +0,0 @@
-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