eco-helpers 2.0.11 → 2.0.16

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

@@ -3,39 +3,49 @@ module Eco
     module Organization
 
       class PresetsFactory
+
+        class << self
+
+          def all_abilities(hash = {})
+            Hash[abilities.each_with_object(nil).to_a].merge(hash)
+          end
+
+          def abilities_model
+            @abilities_model ||= JSON.load(File.open(ABILITIES))
+          end
+
+          def integrity_model
+            @integrity_model ||= JSON.load(File.open(INTEGRITY))
+          end
+
+          def abilities
+            @abilities ||= abilities_model.keys
+          end
+
+        end
+
         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 +54,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 +69,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 +81,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
+          self.class.integrity_model
+        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
+          self.class.abilities_model
+        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.rb

@@ -105,10 +105,15 @@ module Eco
           iterations = (data.length.to_f / per_page).ceil
 
           Eco::API::Session::Batch::Status.new(enviro, queue: data, method: method).tap do |status|
+            start_time  = Time.now
+            start_slice = Time.now; slice = []
             data.each_slice(per_page) do |slice|
-              msg = "starting batch '#{method}' iteration #{iteration}/#{iterations}, with #{slice.length} entries of #{data.length} -- #{done} done"
+              msg  = "starting batch '#{method}' iteration #{iteration}/#{iterations},"
+              msg += " with #{slice.length} entries of #{data.length} -- #{done} done"
+              msg += " (last: #{str_stats(start_slice, slice.length)}; total: #{str_stats(start_time, done)})"
               logger.info(msg) unless silent
 
+              start_slice = Time.now
               people_api.batch do |batch|
                 slice.each do |person|
                   batch.public_send(method, person) do |response|
@@ -118,12 +123,23 @@ module Eco
                 end
               end # next batch
 
-              iteration += 1
-              done += slice.length
+              iteration  += 1
+              done       += slice.length
             end # next slice
           end
         end
 
+        def str_stats(start, count)
+          now     = Time.now
+          secs    = (now - start).round(3)
+          if secs > 0.0
+            per_sec = (count.to_f / secs).round(2)
+            "#{secs}s -> #{per_sec} people/s"
+          else
+            " -- "
+          end
+        end
+
       end
     end
   end

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/session/config.rb

@@ -159,6 +159,8 @@ module Eco
         end
 
         def working_directory(mode: nil)
+          return files.working_directory if apis.active_api&.one_off?
+
           unless mode
             wd = files.working_directory
             return wd unless wd.to_s.strip.empty?
@@ -183,12 +185,21 @@ module Eco
         end
 
         def require(file = nil, match: nil)
-          if match
-            file_manager.dir.dir_files(pattern: match).each do |file|
-              require_relative File.expand_path(file)
+          begin
+            if match
+              file_manager.dir.dir_files(pattern: match).each do |file|
+                require_relative File.expand_path(file)
+              end
+            else
+              target = File.expand_path(file_manager.dir.file(file))
+              require_relative target
+            end
+          rescue LoadError => e
+            if apis.active_api.one_off?
+              pp e.to_s
+            else
+              raise
             end
-          else
-            require_relative "#{File.expand_path(file_manager.dir.file(file))}"
           end
         end
         # @!endgroup

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

@@ -83,6 +83,10 @@ module Eco
             self["name"]
           end
 
+          def one_off?
+            name.is_a?(Symbol)
+          end
+
           def key
             self["key"]
           end