eco-helpers 2.0.13 → 2.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 726f5a5930889b9fd59b4acc4ce7b938e3c6011909c2f5a5bb1a105a36df4d9b
-  data.tar.gz: 804bc3ae796491543ec3615e9f11308333e7ea6fc9a10f943778f66922aa4a25
+  metadata.gz: 697d71754e809691a39f62a86d5fc46e2988578c19c965945e1c06ea73b290b6
+  data.tar.gz: 01ef5ca1a9bcf941d44b5f7088f54dd9c2cba950cc562ed0516400811df60f12
 SHA512:
-  metadata.gz: f2e1c852b4660ae1bdc3e94bab274f3d4b7168c6affef57315b370af102b71cff19cdb0c2de0b59899f82b7f2f8b0478688cf018f3c52f26c1f1d891ed19cd65
-  data.tar.gz: 032a93267eb45f7550fbdad7805d0f472a0ea1a98353b089147bd71de785cdeaa4933b233bdd22d4ab69f7a85bfa65ec1f0850fe82e446dcf4d5f503ba1f191b
+  metadata.gz: b24db6ddf741e3f0dcc3f080dba19132d7926c85cf211ae0f98c090c7a3cd93f513b6e977ac21ca24d5c2092d524cc1e7ef3d04250bb29ae672400623c823964
+  data.tar.gz: 9585e95676aab71322af2f174d06aed7d6226502bed1e2560cfd0915643e682c02fb857c33310f7c5f1b6d083b83267d14194f0f1e315c940048ef1c3c43faff

data/CHANGELOG.md

@@ -1,14 +1,24 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.0.14] - 2021-03-xx
+
+### Added
+  - `Eco::API::UseCases::DefaultCases::ToCsvCase` added option `-internal-names` to avoid overriding data on export
+  - `Eco::API::Common::People::PersonEntry#mapped_entry` exposed method for raw `csv` generation
+  - `Eco::API::Organization::PresetsFactory` added integrity validation for `person_*` abilities
+  - `Eco::API::Session::Batch::Job` more debug info on erron handlers
+
+### Changed
+### Fixed
+  - `Eco::API::Error.get_type` was almost always matching `Eco::API::Error::Unclassified` -> fixed
+
 ## [2.0.13] - 2021-03-31
 
 ### Added
   - Stats on the `Eco::API::Session::Batch`
   - Allow to inherit and re-use the `Eco::API::UseCases::DefaultCase::HrisCase`
 
-### Changed
-
 ### Fixed
   - Ensure auto-loading for `Eco::API::UseCases`
 

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

@@ -57,6 +57,11 @@ module Eco
             @internal_entry
           end
 
+          # @return [Hash] entry `Hash` with **internal** attribute names, but **external** types and values.
+          def mapped_entry
+            @mapped_entry
+          end
+
           # @note values ready to be set to a person.
           # @return [Hash] entry `Hash` with **internal** attribute names, values and types.
           def final_entry

data/lib/eco/api/error.rb

@@ -80,6 +80,7 @@ module Eco
             next  1 if k1 < k2
             0
           end.tap do |siblings|
+            siblings.delete(Unclassified)
             if direct
               siblings.reject! do |si|
                 siblings.any? {|s| si < s}
@@ -96,17 +97,18 @@ module Eco
           err_msg =~ @match
         end
 
-        def get_type(err_msg)
+        def get_type(err_msg, first: true)
           type = nil
           descendants(direct: true).reverse.each do |klass|
             if klass.err_match?(err_msg)
               type = klass
               if klass.descendants?(direct: true)
-                type = klass.get_type(err_msg) || type
+                type = klass.get_type(err_msg, first: false) || type
               end
             end
           end
-          type
+          return type unless first
+          type || Unclassified
         end
 
         def known_err_class?(klass)

data/lib/eco/api/organization/presets_factory.rb

@@ -4,38 +4,27 @@ module Eco
 
       class PresetsFactory
         ABILITIES = File.join(__dir__, 'presets_values.json')
+        INTEGRITY = File.join(__dir__, 'presets_integrity.json')
         DEFAULT_CUSTOM = 'presets_custom.json'
         DEFAULT_MAP    = 'presets_map.json'
 
         def initialize(presets_custom: DEFAULT_CUSTOM, presets_map: DEFAULT_MAP, enviro: nil, policy_groups: nil)
-          @abilities  = JSON.load(File.open(ABILITIES))
-          @habilities = @abilities.map do |key, values|
-            h_values = values.map { |v| [v, true] }.to_h
-            [key, h_values]
-          end.to_h
-
           fatal("Expecting Environment object. Given: #{enviro}") if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
-          @enviro = enviro
-
-          policy_groups = policy_groups || @enviro&.api&.policy_groups.to_a
-          if policy_groups.is_a?(Eco::API::Organization::PolicyGroups)
-            @policy_groups = policy_groups
-          else
-            @policy_groups = Eco::API::Organization::PolicyGroups.new(policy_groups)
-          end
+          @enviro        = enviro
 
-          init_custom(presets_custom)
-          init_map(presets_map)
+          @policy_groups       = policy_groups
+          @presets_custom_file = presets_custom || DEFAULT_CUSTOM
+          @presets_map_file    = presets_map    || DEFAULT_MAP
         end
 
         def new(*policy_group_ids_or_names)
 
           names = policy_group_ids_or_names.map do |id_name|
-            @policy_groups.to_name(id_name)&.downcase
+            policy_groups.to_name(id_name)&.downcase
           end.compact
 
-          if @presets_map
-            preset_names = names.map { |name| @presets_map.fetch(name, nil) }
+          if presets_map
+            preset_names = names.map { |name| presets_map.fetch(name, nil) }
           else # option to do not use preset mapping (so just the policy group name)
             preset_names = names
           end
@@ -44,69 +33,11 @@ module Eco
 
         # @return [Array<String>] all the abilities
         def keys
-          @abilities.keys
+          abilities_model.keys
         end
 
         private
 
-        def init_custom(file = DEFAULT_CUSTOM)
-          @presets_custom = nil
-
-          return if !file
-          file = File.expand_path(file)
-
-          if File.exists?(file)
-            @presets_custom = JSON.load(File.open(file))
-
-            errors = @presets_custom.map do |key, preset|
-              (err = preset_errors(preset)) ? "{ '#{key}' preset -> #{err}}": nil
-            end.compact
-
-            fatal("File '#{file}' contains invalid presets:\n  #{errors.join("\n  ")}") if errors.length > 0
-          end
-
-        end
-
-        def init_map(file = DEFAULT_MAP)
-          @presets_map = nil
-
-          return if !file
-          file = File.expand_path(file)
-
-          if File.exists?(file)
-            fatal("Maps file specified without custom presets file. Aborting!") if !@presets_custom
-            @presets_map = JSON.load(File.open(file))
-
-            errors = []
-            if @policy_groups.length > 0
-              errors = @policy_groups.map do |pg|
-                exists = @presets_map[pg.name.downcase] || @presets_custom[pg.name.downcase]
-                exists ? nil : "'#{pg.name}'"
-              end.compact
-
-              warn("No maps or no preset for policy group(s): #{errors.join(", ")}") if errors.length > 0
-            end
-
-            errors = @presets_map.map do |source, dest|
-              @presets_custom[dest] ? nil : "'#{dest}'"
-            end.compact
-
-            warn("Unexisting mapped preset(s): #{errors.uniq.join(", ")}") if errors.length > 0
-          end
-
-        end
-
-        def fatal(msg)
-          raise msg if !@enviro
-          @enviro.logger.fatal(msg)
-          raise msg
-        end
-
-        def warn(msg)
-          raise msg if !@enviro
-          @enviro.logger.warn(msg)
-        end
-
         def compile(*preset_names)
           fatal("You need to specify an existing file for the custom presets.") if !@presets_custom
           @presets_custom.values_at(*preset_names).compact.reduce({}) do |p1, p2|
@@ -117,7 +48,7 @@ module Eco
         def merge(preset1, preset2)
           keys = preset1.keys | preset2.keys
 
-          @abilities.each_with_object({}) do |(key, values), result|
+          abilities_model.each_with_object({}) do |(key, values), result|
             next unless keys.include?(key)
             idx = [
               values.index(preset1[key]),
@@ -129,17 +60,149 @@ module Eco
 
         # unsused: only play with the given abilities
         def empty_model
-          JSON.parse(@abilities.to_json).transform_values {|v| nil }
+          JSON.parse(abilities_model.to_json).transform_values {|v| nil }
         end
 
         def preset_errors(preset)
           return "No preset given" if !preset
           errors = preset.map do |k, v|
-            @habilities.dig(k, v) ? nil : "#{k}:#{v}"
+            value_exists?(k, v) ? nil : "#{k}:#{v}"
           end.compact
-          return " unknown: {#{errors.join(", ")}}" if errors.length > 0
+          return " Unknown: {#{errors.join(", ")}}" if errors.length > 0
           nil
         end
+
+        def preset_integrity(preset)
+          preset.each_with_object([]) do |(ability, value), errors|
+            next unless checks = integrity_model[ability]
+
+            suberrors = []
+
+            checks.each do |check|
+              next unless check["value"] == value
+              check["conditions"].each do |cond, targets|
+                case cond
+                when "at_least"
+                  targets.each do |other, minimum|
+                    unless (ability_value_idx(other, minimum) <= ability_value_idx(other, preset[other]))
+                      suberrors << "'#{other}' should be at least '#{minimum}'"
+                    end
+                  end
+                when "one_of"
+                  unless targets.any? {|other, expected| preset[other] == expected}
+                    suberrors << targets.each_with_object([]) do |(other, expected), out|
+                      out << "'#{other}': '#{expected}'"
+                    end.join(", ").yield_self do |msg|
+                      "there should be at least one of: {#{msg}}"
+                    end
+                  end
+                else
+                  warn("Unsuported integrity condition statement '#{cond}' in '#{ability}' with level '#{value}'")
+                end
+              end
+            end
+
+            if suberrors.length > 0
+              errors << "Incorrect value '#{value}' for '#{ability}' - reasons: {#{suberrors.join(", ")}}"
+            end
+          end.yield_self do |errors|
+            " Integrity errors: { #{errors.join(", ")} }" if errors.length > 0
+          end
+        end
+
+        def integrity_model
+          @integrity_model ||= JSON.load(File.open(INTEGRITY))
+        end
+
+        def value_exists?(ability, value)
+          abilities_model_inverted.dig(ability, value)
+        end
+
+        def abilities_model_inverted
+          @abilities_model_inverted ||= abilities_model.each_with_object({}) do |(key, values), out|
+            out[key] = values.each_with_object({}) {|v, h| h[v] = true }
+          end
+        end
+
+        def ability_value_idx(ability, value)
+          abilities_model[ability].index(value)
+        end
+
+        def abilities_model
+          @abilities_model ||= JSON.load(File.open(ABILITIES))
+        end
+
+        def policy_groups
+          return @policy_groups if @policy_groups.is_a?(Eco::API::Organization::PolicyGroups)
+          @policy_groups ||= @enviro&.api&.policy_groups.to_a
+
+          unless @policy_groups.is_a?(Eco::API::Organization::PolicyGroups)
+            @policy_groups = Eco::API::Organization::PolicyGroups.new(@policy_groups)
+          end
+          @policy_groups
+        end
+
+        def presets_custom
+          return @presets_custom if instance_variable_defined?(:@presets_custom)
+          @presets_custom = nil
+          if @presets_custom_file
+            if (file = File.expand_path(@presets_custom_file)) && File.exists?(file)
+              @presets_custom = JSON.load(File.open(file)).tap do |custom_presets|
+                errors = custom_presets.each_with_object([]) do |(key, preset), errors|
+                  if err = preset_errors(preset)
+                    errors << "{ '#{key}' preset -> #{err}}"
+                  end
+                  if err = preset_integrity(preset)
+                    errors << "{ '#{key}' preset -> #{err}}"
+                  end
+                end
+
+                fatal("File '#{file}' contains invalid presets:\n  #{errors.join("\n  ")}") if errors.length > 0
+              end
+            end
+          end
+        end
+
+        def presets_map
+          return @presets_map if instance_variable_defined?(:@presets_map)
+          @presets_map = nil
+          if @presets_map_file
+            if (file = File.expand_path(@presets_map_file)) && File.exists?(file)
+              fatal("Maps file specified without 'presets_custom.json' file. Aborting!") if !presets_custom
+              @presets_map = JSON.load(File.open(file)).tap do |map_presets|
+
+                errors = []
+                if policy_groups.length > 0
+                  errors = policy_groups.map do |pg|
+                    exists = map_presets[pg.name.downcase] || presets_custom[pg.name.downcase]
+                    exists ? nil : "'#{pg.name}'"
+                  end.compact
+
+                  warn("No maps or no preset for policy group(s): #{errors.join(", ")}") if errors.length > 0
+                end
+
+                errors = map_presets.map do |source, dest|
+                  presets_custom[dest] ? nil : "'#{dest}'"
+                end.compact
+
+                warn("Unexisting mapped preset(s): #{errors.uniq.join(", ")}") if errors.length > 0
+
+              end
+            end
+          end
+        end
+
+        def fatal(msg)
+          raise msg if !@enviro
+          @enviro.logger.fatal(msg)
+          raise msg
+        end
+
+        def warn(msg)
+          raise msg if !@enviro
+          @enviro.logger.warn(msg)
+        end
+
       end
 
     end

data/lib/eco/api/organization/presets_integrity.json

@@ -0,0 +1,52 @@
+{
+  "person_core_create": [
+    { "value": "create", "conditions": {
+        "at_least": {"person_core": "view_people_manager"}
+      }
+    }
+  ],
+  "person_core_edit": [
+    { "value": "edit", "conditions": {
+        "at_least": {"person_core": "view_people_manager"}
+      }
+    }
+  ],
+  "person_details": [
+    { "value": "view", "conditions": {
+        "at_least": {"person_core": "attach"}
+      }
+    },
+    { "value": "edit_public", "conditions": {
+        "one_of": {
+          "person_core_edit":   "edit",
+          "person_core_create": "create"
+        }
+      }
+    },
+    { "value": "view_private", "conditions": {
+        "at_least": {"person_core": "attach" }
+      }
+    },
+    { "value": "edit_private", "conditions": {
+        "one_of": {
+          "person_core_edit":   "edit",
+          "person_core_create": "create"
+        }
+      }
+    }
+  ],
+  "person_account": [
+    { "value": "view", "conditions": {
+        "at_least": {"person_core": "attach" }
+      }
+    },
+    { "value": "create", "conditions": {
+        "at_least": {"person_core_create": "create"}
+      }
+    },
+    { "value": "edit", "conditions": {
+        "at_least": {"person_core_edit": "edit"}
+      }
+    }
+  ]
+}

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

@@ -288,10 +288,13 @@ module Eco
               handlers = session.config.error_handlers
               if status.errors.any? && !handlers.empty? && !error_handler?
                 err_types = status.errors.by_type
+                logger.debug("(#{self.name}) got these error types: #{err_types.keys}")
                 handlers.each do |handler|
                   if entries = err_types[handler.name]
                     handler_job = subjobs_add("#{self.name} => #{handler.name}", usecase: handler)
+                    logger.debug("Running error handler #{handler.name}")
                     handler.launch(people: people(entries), session: session, options: options, job: handler_job)
+                    logger.debug("Launching job of error handler: #{handler_job.name}")
                     handler_job.launch(simulate: simulate)
                   end
                 end

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

@@ -2,7 +2,11 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
   name "to-csv"
   type :export
 
+  attr_reader :session, :options, :people
+
   def main(people, session, options, usecase)
+    @session = session; @options = options; @people = people
+
     unless people && !people.empty?
       session.logger.warn("No source people to create the file... aborting!")
       return false
@@ -14,32 +18,48 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
     end
 
     session.logger.info("going to create file: #{file}")
-    CSV.open(file, "w") do |csv|
-      deps   = {"supervisor_id" => {people: people}}
-      entry  = session.new_entry(people.first, dependencies: deps)
-      header = entry.external_entry.keys
-
-      if options.dig(:nice_header) || options.dig(:export, :options, :nice_header)
-        name_maps = session.schema.fields_by_alt_id.transform_values do |fld|
-          fld.name
-        end.merge({
-          "policy_group_ids" => "User Group(s)",
-          "email"            => "Email",
-          "name"             => "Name",
-          "supervisor_id"    => "Manager ID",
-          "filter_tags"      => "Locations",
-          "default_tag"      => "Default Location",
-          "id"               => "ecoPortal ID"
-        })
-        header = header.map {|name| name_maps[name] ? name_maps[name] : name}
-      end
 
-      csv << header
+    CSV.open(file, "w") do |csv|
+      csv << spot_header
       people.each do |person|
-        csv << session.new_entry(person, dependencies: deps).external_entry.values
+        csv << target_entry_type(person).values
       end
     end
     exit(0)
   end
 
+  private
+
+  def target_entry_type(person)
+    session.new_entry(person, dependencies: deps).yield_self do |person_entry|
+      options.dig(:export, :options, :internal_names) ? person_entry.mapped_entry : person_entry.external_entry
+    end
+  end
+
+  def deps
+    @deps ||= {"supervisor_id" => {people: people}}
+  end
+
+  def spot_header
+    entry  = target_entry_type(people.first)
+    header = entry.keys
+
+    if options.dig(:nice_header) || options.dig(:export, :options, :nice_header)
+      name_maps = session.schema.fields_by_alt_id.transform_values do |fld|
+        fld.name
+      end.merge({
+        "policy_group_ids" => "User Group(s)",
+        "email"            => "Email",
+        "name"             => "Name",
+        "supervisor_id"    => "Manager ID",
+        "filter_tags"      => "Locations",
+        "default_tag"      => "Default Location",
+        "id"               => "ecoPortal ID"
+      })
+      header = header.map {|name| name_maps[name] ? name_maps[name] : name}
+    end
+    header
+  end
+
+
 end

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

@@ -6,7 +6,7 @@ ASSETS.cli.config do |cnf|
       file = SCR.get_file("-people-to-csv", required: true, should_exist: false)
       options.deep_merge!(export: {file: {name: file, format: :csv}})
       options.deep_merge!(export: {options: {nice_header: true}}) if SCR.get_arg("-nice-header")
-
+      options.deep_merge!(export: {options: {internal_names: true}})  if SCR.get_arg("-internal-names")
       case_name = SCR.get_arg("-detailed")? "to-csv-detailed" : "to-csv"
       session.usecases.case(case_name)
     end
@@ -73,7 +73,7 @@ ASSETS.cli.config do |cnf|
       end
 
       options.deep_merge!(ignore: {missing: {policy_groups: true}}) if SCR.get_arg("-ignore-missing-policy-groups")
-      
+
     end
 
     desc = "Restores the people manager by using a backup.json file"

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.13"
+  VERSION = "2.0.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.13
+  version: 2.0.14
 platform: ruby
 authors:
 - Oscar Segura
@@ -340,6 +340,7 @@ files:
 - lib/eco/api/organization/preferences.rb
 - lib/eco/api/organization/preferences_reference.json
 - lib/eco/api/organization/presets_factory.rb
+- lib/eco/api/organization/presets_integrity.json
 - lib/eco/api/organization/presets_reference.json
 - lib/eco/api/organization/presets_values.json
 - lib/eco/api/organization/tag_tree.rb