eco-helpers 2.0.9 → 2.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75a468069bd29d7dc25347e6da7d4d9faebc52043eba8b4ea1e91f6d383a8690
-  data.tar.gz: dee338f8e23d4608f0d359bd44712377d15723c70730e823c11766f179f4877e
+  metadata.gz: 697d71754e809691a39f62a86d5fc46e2988578c19c965945e1c06ea73b290b6
+  data.tar.gz: 01ef5ca1a9bcf941d44b5f7088f54dd9c2cba950cc562ed0516400811df60f12
 SHA512:
-  metadata.gz: 36c25c8a37c8fe894c57309e07126251e658846881698d4eec1660bf2a1a6cdc2e09f6b3f94c28434e47e7ea1f70cbf69196d2965d0a45609492867b2b356478
-  data.tar.gz: 98bdbf74599ab4a3ab98ac6c76d068bbcf7871774e3f7315f992dbcb9cc31066ac7d2293b8cbee1bc3019bf94e1b9f78c7fdf02b8751cafb403451be12c8c159
+  metadata.gz: b24db6ddf741e3f0dcc3f080dba19132d7926c85cf211ae0f98c090c7a3cd93f513b6e977ac21ca24d5c2092d524cc1e7ef3d04250bb29ae672400623c823964
+  data.tar.gz: 9585e95676aab71322af2f174d06aed7d6226502bed1e2560cfd0915643e682c02fb857c33310f7c5f1b6d083b83267d14194f0f1e315c940048ef1c3c43faff

data/CHANGELOG.md

@@ -1,32 +1,71 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.9] - 2021-03-xx
+## [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
-  - `Eco::API::Session::Batch:Errors#person_ref` moved to the public method
+### 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`
 
 ### Fixed
+  - Ensure auto-loading for `Eco::API::UseCases`
 
-## [2.0.8] - 2021-03-09
+## [2.0.12] - 2021-03-29
+
+### Changed
+  - `Eco::CLI#run` it does include any defined states on the workflow
+
+
+## [2.0.11] - 2021-03-29
+
+### Fixed
+  - `Eco::API::Session::Batch:Errors#errors` changed `Array#filter` call to `Array#select` call
+
+## [2.0.10] - 2021-03-26
 
 ### Added
+  - `Eco::API::Common::People::PersonParser`
+    - `#defined_attrs`: list of all attribute defined parsers (regardless they belong to the model)
+  - `Eco::API::Organization::TagTree` methods
+    - `#total_depth` to know the total depth of a tree
+    - `#flat?` to know if the tagtree has only 1 level
+
 ### Changed
+  - `Eco::API::Common::People::PersonParser`
+    - Renamed `#all_attrs` to `#all_model_attrs`
+    - Ranamed `#defined_attrs` to `#defined_model_attrs`
+    - Ranamed `#undefined_attrs` to `#undefined_model_attrs`
+
+## [2.0.9] - 2021-03-19
+
+### Changed
+  - `Eco::API::Session::Batch:Errors#person_ref` moved to the public method
+
+## [2.0.8] - 2021-03-09
+
 ### Fixed
   - `Ecoportal::API::V1::Person#identity` adjust behavior
 
 ## [2.0.7] - 2021-03-09
 
-### Added
-### Changed
 ### Fixed
   - `Eco::API::Session::Batch::JobsGroups` and `Eco::API::Session::Batch::Jobs`: when new `Batch::Job`s are creating during launch, they remained unlaunched
     - this fix makes `#launch` method to iterate until there are no pending
 
 ## [2.0.6] - 2021-03-08
 
-### Added
 ### Changed
   - `Eco::API::Session::Batch:Errors` moved some methods to be private
 ### Fixed
@@ -34,46 +73,33 @@ All notable changes to this project will be documented in this file.
 
 ## [2.0.5] - 2021-02-24
 
-### Added
-### Changed
 ### Fixed
   - `Eco::API::Common::People::PersonParser#symbol_keys` to use `Array#select`
     - as `Array#filter` was introduced in ruby `2.5.5`
 
 ## [2.0.4] - 2021-02-23
 
-### Added
 ### Changed
   - `Eco::API::Common::People::PersonParser#defined_attrs` to include virtual attributes
 
-### Fixed
-
 ## [2.0.3] - 2021-02-23
 
 ### Added
   - `Eco::API::UseCases::OozeSamples::OozeUpdateCase`: added integration to update page instances (non-templates)
 
-### Changed
 ### Fixed
   - `Eco::API::Policies::DefaultPolicies::UserAccess` complete default policy code.
 
 ## [2.0.2] - 2021-02-22
 
-### Added
 ### Changed
   - upgraded dependencies with `ecoportal-api`
 
-### Fixed
-
-
 ## [2.0.1] - 2021-02-22
 
-### Added
 ### Changed
   - upgraded dependencies with `ecoportal-api-oozes` to `ecoportal-api-v2`
 
-### Fixed
-
 ## [1.5.15] - 2021-02-17
 
 ### Added
@@ -87,7 +113,6 @@ All notable changes to this project will be documented in this file.
     - `Eco::API::MicroCases#people_search`
     - `Eco::API::MicroCases#refresh`
 
-### Changed
 ### Fixed
   - `Eco::API::Policies::DefaultPolicies::UserAccess` typos in default api policy
 
@@ -109,11 +134,8 @@ All notable changes to this project will be documented in this file.
   - `Eco::API::Common::People::PersonEntry` add error log when wrong email error is detected
     - previously it would have crashed
 
-### Fixed
-
 ## [1.5.13] - 2021-02-01
 
-### Added
 ### Changed
   - upgraded dependency with `ecoportal-api-oozes`
 
@@ -129,23 +151,16 @@ All notable changes to this project will be documented in this file.
 ### Changed
   - upgraded `ecoportal-api` dependency
 
-### Fixed
-
-
 ## [1.5.11] - 2021-01-25
 
 ### Added
   - `Eco::API::Organization::TagTree#subtag?` to check if the tag is in any subtree.
 
-### Changed
-
 ### Fixed
   - `Eco::API::MicroCases#set_supervisor` shouldn't set it if the entry does not have it.
 
 ## [1.5.10] - 2021-01-19
 
-### Added
-### Changed
 ### Fixed
   - `Eco::API::Session::Batch::Errors#print` show the row number of the input data.
 
@@ -154,14 +169,8 @@ All notable changes to this project will be documented in this file.
 ### Added
   - `Eco::API::Organization::TagTree#subtags` to get all the tags but those of the highest level.
 
-### Changed
-### Fixed
-
-
 ## [1.5.8] - 2021-01-05
 
-### Added
-### Changed
 ### Fixed
   - `Eco::API::Session::Batch::Jobs#job` shouldn't be calling the post-launch callback function on creation.
   - `Eco::API::Session#new_job` should include a `&block` parameter.
@@ -169,15 +178,11 @@ All notable changes to this project will be documented in this file.
 
 ## [1.5.7] - 2020-12-17
 
-### Added
-### Changed
 ### Fixed
   - `Eco::API::Sesssion#parse_attribute` was not using phase argument
 
 ## [1.5.6] - 2020-12-04
 
-### Added
-### Changed
 ### Fixed
   - `Eco::API::UseCases::DefaultCases::RestoreDBCase` fixed typo and slightly improved
   - fixed some back-end errors when chaining usecases
@@ -185,8 +190,6 @@ All notable changes to this project will be documented in this file.
 
 ## [1.5.5] - 2020-12-03
 
-### Added
-### Changed
 ### Fixed
   - rubies previous to `2.5` do not have `yield_self`
 
@@ -194,14 +197,11 @@ All notable changes to this project will be documented in this file.
 
 ### Added
   - update `ecoportal-api` dependency
-### Changed
 ### Fixed
   - `Eco::API::MicroCases#people_refresh` typo
 
 ## [1.5.3] - 2020-11-30
 
-### Added
-### Changed
 ### Fixed
   - `Eco::API::Session::Batch::RequestStats#blanked_value?` better blank detection
   - `Eco::API::MicroCases#with_each_starter` rectified typo
@@ -342,14 +342,11 @@ All notable changes to this project will be documented in this file.
 
 ## [1.4.2] - 2020-07-23
 
-### Added
-### Changed
 ### Fixed
   - preserve backtrace on logging
 
 ## [1.4.0] - 2020-07-14
 
-### Added
 ### Changed
   - change abilities to align with ecoPortal release `1.5.0`
   - remove some patches on `ecoportal-api`
@@ -359,22 +356,17 @@ All notable changes to this project will be documented in this file.
 
 ## [1.3.19] - 2020-07-23
 
-### Added
-### Changed
 ### Fixed
   - preserve backtrace on logging
 
 ## [1.3.18] - 2020-07-08
 
-### Added
-### Changed
 ### Fixed
   - the `update` case was missing the code to use the `default_usergroup`
 
 
 ## [1.3.17] - 2020-07-06
 
-### Added
 ### Changed
   - the `hris` case should not only include as `leavers` those that have account, but anyone that leaves
     * as we could have active people with no account
@@ -397,7 +389,6 @@ All notable changes to this project will be documented in this file.
 ### Added
   - default usecase to export to `csv` (`-detailed`) now includes `"Supervisor Name"` column
 ### Changed
-### Fixed
 
 ## [1.3.14] - 2020-06-10
 
@@ -405,33 +396,24 @@ All notable changes to this project will be documented in this file.
   - `Eco::API::Common::People::SupervisorHelpers` now has its methods as class methods
 ### Changed
   - upgraded `ecoportal-api` gem dependency to minimum version `0.5.6`
-### Fixed
 
 
 ## [1.3.13] - 2020-05-29
 
-### Added
-### Changed
 ### Fixed
   - `Eco::API::Organization::TagTree#tag?` to accept `nil` by returning `false`
   - `Eco::API::Common::People::DefaultParsers::DateParser` will parse to `Date` class
     * it was parsing to `Time` class, while the native gem `ecoportal-api` parses as `Date` ([reference](https://gitlab.com/ecoPortal/ecoportal-api/-/blob/master/lib/ecoportal/api/v1/schema_field.rb))
 ## [1.3.12] - 2020-05-19
 
-### Added
 ### Changed
   - stop using `email` as `external_id` on `People#person` & `People#find`
     * this should result in more accurate searches when using `:strict` options
-### Fixed
-
 
 ## [1.3.11] - 2020-05-12
 
-### Added
 ### Changed
   - remove popping up comments on `Eco::API::Organization::PolicyGroups#`
-### Fixed
-
 
 ## [1.3.10] - 2020-05-12
 
@@ -440,14 +422,11 @@ All notable changes to this project will be documented in this file.
   - `config.people.default_usergroup`, when defined, will have effect on usecases: `update` (this case was missing the change)
     * on account creation, if the input file did not specify `policy_group_ids`
 
-### Changed
 ### Fixed
   - `upsert`, `hris` and `create` usecases: fixed condition for use of default_usergroup
 
 ## [1.3.9] - 2020-05-12
 
-### Added
-### Changed
 ### Fixed
 
 - `usecase` callback was not receiving `usecase` paramater

data/lib/eco/api/common/loaders/use_case.rb

@@ -8,7 +8,7 @@ module Eco
             # @return [Symbol] the `type` of usecase (i.e. `:sync`, `:transform`, `:import`, `:other`)
             def type(value = nil)
               unless value
-                return @type || raise("You should specify a type of case [:sync, :transform, :import, :other] for #{self.class}")
+                return @type || raise("You should specify a type of case [:sync, :transform, :import, :other] for #{self}")
               end
               @type = value
             end

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
@@ -256,7 +261,7 @@ module Eco
           # @param mapped_entry [Hash] that with **internal** names but **external** values and types.
           # @return [Hash] with **external** names, values and types.
           def _external_serializing(mapped_entry)
-            target_attrs    = @emap.all_attrs | @emap.aliased_attrs
+            target_attrs    = @emap.all_model_attrs | @emap.aliased_attrs
             rest_keys       = mapped_entry.keys - target_attrs
             target_attrs   -= ["send_invites"]
             external_entry  = target_attrs.each_with_object({}) do |attr, hash|

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

@@ -6,14 +6,14 @@ module Eco
         # @attr_reader core_attrs [Array<String>] core attributes that are present in the person entry.
         # @attr_reader details_attrs [Array<String>] schema details attributes that are present in the person entry.
         # @attr_reader account_attrs [Array<String>] account attributes that are present in the person entry.
-        # @attr_reader all_attrs [Array<String>] all the attrs that are present in the person entry.
+        # @attr_reader all_model_attrs [Array<String>] all the attrs that are present in the person entry.
         # @attr_reader internal_attrs [Array<String>] all the internally named attributes that the person entry has.
         # @attr_reader aliased_attrs [Array<String>] only those internal attributes present in the person entry that have an internal/external name mapping.
         # @attr_reader direct_attrs [Array<String>] only those internal attributes present in the person entry that do **not** have an internal/external name mapping.
         class PersonEntryAttributeMapper
           @@cached_warnings = {}
 
-          attr_reader :core_attrs, :details_attrs, :account_attrs, :all_attrs
+          attr_reader :core_attrs, :details_attrs, :account_attrs, :all_model_attrs
           attr_reader :internal_attrs, :aliased_attrs, :direct_attrs
 
           # Helper class tied to `PersonEntry` that allows to track which attributes of a person entry are present
@@ -41,14 +41,14 @@ module Eco
               init_attr_trackers
             else  # SERIALIZING
               @person          = data
-              @internal_attrs  = @person_parser.all_attrs
+              @internal_attrs  = @person_parser.all_model_attrs
               @aliased_attrs   = @attr_map.list(:internal)
             end
 
             @core_attrs    = @person_parser.target_attrs_core(@internal_attrs)
             @details_attrs = @person_parser.target_attrs_details(@internal_attrs)
             @account_attrs = @person_parser.target_attrs_account(@internal_attrs)
-            @all_attrs     = @core_attrs | @account_attrs | @details_attrs
+            @all_model_attrs = @core_attrs | @account_attrs | @details_attrs
           end
 
           # To know if currently the object is in parse or serialize mode.
@@ -98,7 +98,7 @@ module Eco
               end
             end
 
-            return nil unless @person_parser.all_attrs.include?(attr)
+            return nil unless @person_parser.all_model_attrs.include?(attr)
           end
 
           # Serializing helper also used to do a reverse mapping when parsing:
@@ -146,9 +146,9 @@ module Eco
           # when parsing:
           def init_attr_trackers
             # (def) all internal attributes we can expect
-            def_all_attrs     = @person_parser.all_attrs
+            def_all_attrs     = @person_parser.all_model_attrs
             # (def) internal attrs with no aliasing nor parser definition (expected to be direct)
-            def_unlinked      = @person_parser.undefined_attrs.select { |attr| !to_external(attr) }
+            def_unlinked      = @person_parser.undefined_model_attrs.select { |attr| !to_external(attr) }
             # (def) those with parser or alias:
             def_linked        = def_all_attrs - def_unlinked
 
@@ -168,7 +168,7 @@ module Eco
             # (data) virtual internal attrs (the internal names of those virtual attrs)
             data_vi_int_aliased = data_vi_ext_alias.map do |attr|
               # to_internal(attr) can't be used here, becauase virtual fields would get filtered out,
-              # as they are not recognized by @parser.all_attrs.include?(attr)
+              # as they are not recognized by @parser.all_model_attrs.include?(attr)
               @attr_map.to_internal(attr)
             end.compact
 

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

@@ -7,7 +7,7 @@ module Eco
         #
         # @attr_reader schema [Ecoportal::API::V1::PersonSchema, nil] schema of person details that this parser will be based upon.
         # @attr_reader details_attrs [Array<String>] internal names of schema details attributes.
-        # @attr_reader all_attrs [Array<String>] all the internal name attributes, including _core_, _account_ and _details_.
+        # @attr_reader all_model_attrs [Array<String>] all the internal name attributes, including _core_, _account_ and _details_.
         class PersonParser
           extend  Eco::API::Common::ClassAutoLoader
           autoloads_children_of     "Eco::API::Common::Loaders::Parser"
@@ -19,8 +19,7 @@ module Eco
           FORMAT        = [:csv, :xml, :json]
 
           attr_reader :schema
-          attr_reader :details_attrs, :all_attrs
-          attr_reader :defined_attrs
+          attr_reader :details_attrs, :all_model_attrs
           attr_reader :patch_version
 
           # @example Example of usage:
@@ -46,7 +45,7 @@ module Eco
               @details_attrs  = @schema&.fields.map { |fld| fld.alt_id }
             end
 
-            @all_attrs = CORE_ATTRS + ACCOUNT_ATTRS + @details_attrs
+            @all_model_attrs = CORE_ATTRS + ACCOUNT_ATTRS + @details_attrs
             self.class.autoload_children(self)
           end
 
@@ -60,6 +59,11 @@ module Eco
 
           # @!group Scopping attributes (identifying, presence & active)
 
+          # All the internal name attributes, including _core_, _account_ and _details_.
+          def all_attrs(include_defined_parsers: false)
+            all_model_attrs | defined_model_attrs
+          end
+
           # Scopes `source_attrs` using the _**core** attributes_.
           # @note use this helper to know which among your attributes are **core** ones.
           # @param source_attrs [Array<String>]
@@ -93,14 +97,21 @@ module Eco
             @parsers.keys
           end
 
+          # Returns a list of all the internal attributes that have a parser defined.
+          # @note These attributes do not necessarily belong to the model. They could be virtual attributes
+          # @return [Array<String>] list of all attribute defined parsers.
+          def defined_attrs
+            defined_list - symbol_keys
+          end
+
           # Returns a list of all the internal attributes of the model that have a parser defined.
           # @note
           #  - it excludes any parser that is not in the model, such as type parsers (i.e. `:boolean`, `:multiple`)
           #  - the list is sorted according `CORE_ATTRS` + `ACCOUNT_ATTRS` + schema attrs
-          # @return [Array<String>] list of all attribute defined parsers.
-          def defined_attrs
+          # @return [Array<String>] list of all attribute defined parsers in the model.
+          def defined_model_attrs
             defined     = @parsers.keys
-            defined     = (all_attrs | defined) & defined
+            defined     = (all_model_attrs | defined) & defined
             defined - symbol_keys
           end
 
@@ -118,7 +129,7 @@ module Eco
           # @param process [Symbol] either `:parse` or `:serialize`, depending if we want to parse or serialize the `attr`.
           # @return [Array<String>] list of all attribute defined parsers that should be active for the given `source_data`.
           def active_attrs(source_data, phase = :any, process: :parse)
-            defined_attrs.select do |attr|
+            defined_model_attrs.select do |attr|
               if process == :serialize
                 @parsers[attr].serializer_active?(phase)
               else
@@ -130,8 +141,8 @@ module Eco
           # Returns a list of all the internal attributes of the model that do **not** have a parser defined.
           # @note it excludes any parser that is **not** in the model, such as type parsers (i.e. :boolean, :multiple)
           # @return [Array<String>] list of all attributes without a defined parser.
-          def undefined_attrs
-            all_attrs - defined_attrs
+          def undefined_model_attrs
+            all_model_attrs - defined_model_attrs
           end
 
           # @param attr [String] internal name of an attribute.
@@ -238,7 +249,7 @@ module Eco
           end
 
           def valid_attr?(attr)
-            attr.is_a?(String) && (!@schema || @all_attrs.include?(attr))
+            attr.is_a?(String) && (!@schema || @all_model_attrs.include?(attr))
           end
 
           def valid_type?(attr)

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/organization/tag_tree.rb

@@ -4,7 +4,7 @@ module Eco
 
       # Provides helpers to deal with tagtrees.
       class TagTree
-        attr_reader :tag, :nodes
+        attr_reader :tag, :nodes, :children_count
         attr_reader :depth, :path
         attr_reader :enviro
 
@@ -37,6 +37,7 @@ module Eco
 
           nodes = @source.is_a?(Array) ? @source : @source.dig('nodes') || []
           @nodes = nodes.map {|cnode| TagTree.new(cnode, depth: @depth + 1, path: @path.dup, enviro: @enviro)}
+          @children_count = @nodes.count
 
           init_hashes
         end
@@ -46,6 +47,21 @@ module Eco
           @has_tags.empty?
         end
 
+        # @return [Integer] the highest `depth` of all the children.
+        def total_depth
+          @total_depth ||= if children_count > 0
+              deepest_node = nodes.max_by {|node| node.total_depth}
+              deepest_node.depth
+            else
+              depth
+            end
+        end
+
+        # @return [Integer] if there's only top level.
+        def flat?
+          self.total_depth <= 0
+        end
+
         # Gets all the tags of the current node tree.
         # @note
         #   - this will include the upper level tag(s) as well
@@ -147,7 +163,8 @@ module Eco
         # * take the deepest tag (the one that is further down in the tree)
         # * if there are 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)
+        #    * if there's no common node between them, take the `first`, unless they are at top level of the tree
+        #    * to the above, take the `first` also on top level, but only if there's 1 level for the entire tree
         # @param [Array<String>] values list of tags.
         # @return [String] default tag.
         def default_tag(*values)
@@ -169,7 +186,7 @@ module Eco
             common      = nodes.reduce(self.tags.reverse) {|com, cnode| com & cnode.path.reverse}
             default_tag = common.first if common.length > 0 && depth > 0
           end
-          default_tag = nodes.first&.tag if !default_tag && depth > 0
+          default_tag = nodes.first&.tag  if !default_tag && ( (depth > 0) || flat?)
           default_tag
         end
 

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

@@ -124,7 +124,7 @@ module Eco
           #   - please, observe that this can only happen if there were repeated entries in the `source_queue`
           # @return [Array<Hash>, Array<Ecoportal::API::V1::Person>, Array<Ecoportal::API::Internal::Person>]
           def entries
-            queue.filter.with_index do |query, i|
+            queue.select.with_index do |query, i|
               unless response = status[i]
                 msg  = "Error: query with no response. You might have duplicated entries in your queue.\n"
                 msg += "Queue length: #{queue.length}; Queue elements class: #{queue.first.class}\n"

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

@@ -45,25 +45,22 @@ module Eco
           # @!group Pure feedback methods
 
           # Slightly modifies the behaviour of `Ecoportal::API::Common::BaseModel#as_update`, so schema details fields show the `alt_id`
+          # It also fixes possible patch updates that are incomplete or unnecessary.
           # @note for better feedback
           # @param entry [Hash, Ecoportal::API::V1::Person, Ecoportal::API::Internal::Person]
-          def as_update(entry)
+          # @param add_feedback [Boolean] if `true` it tweak the hash update with additional data.
+          def as_update(entry, add_feedback: true)
             case
             when entry.is_a?(Hash)
               hash = entry
             else #entry.is_a?(Ecoportal::API::V1::Person)
               if only_ids?
-                hash = {
-                  "id"          => entry.id,
-                  "external_id" => entry.external_id,
-                  "email"       => entry.email
-                }
                 hash = entry.as_json.slice("id", "external_id", "email")
               else
                 hash = entry.as_update
-                #if entry.details
-                if hash["details"]
-                  if hfields = hash.dig("details", "fields")
+
+                if add_feedback && details = hash["details"]
+                  if hfields = details["fields"]
                     hfields.each do |fld|
                       fld.merge!("alt_id" => entry.details.get_field(fld["id"]).alt_id)
                     end

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

@@ -169,7 +169,8 @@ module Eco
 
             unless simulate
               if pqueue.length > 0
-                backup_update(requests)
+                req_backup = pqueue.map {|e| as_update(e, add_feedback: false)}
+                backup_update(req_backup)
                 session.batch.launch(pqueue, method: type).tap do |job_status|
                   @status     = job_status
                   status.root = self
@@ -217,7 +218,7 @@ module Eco
             [].tap do |msg|
               subjobs.map {|subjob| msg << subjob.summary}
             end.join("\n")
-          end          
+          end
 
           def as_update(*args)
             feedback.as_update(*args)
@@ -287,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.rb

@@ -30,6 +30,7 @@ module Eco
         @usecases      = {}
         @cache_init    = false
         @cases_by_name = {}
+        init_caches
       end
 
       def length
@@ -79,6 +80,7 @@ module Eco
 
       # @return [Eco::API::UseCases] a copy of instance object of `self`.
       def dup
+        init_caches
         self.class.new.merge(self)
       end
 

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

@@ -2,18 +2,17 @@ class Eco::API::UseCases::DefaultCases::HrisCase < Eco::API::Common::Loaders::Us
   name "hris"
   type :sync
 
+  attr_reader :creation, :update, :supers, :leavers
+
   def main(entries, people, session, options, usecase)
     micro    = session.micro
-    creation = session.new_job("main", "create",  :create, usecase)
-    update   = session.new_job("main", "update",  :update, usecase)
-    supers   = session.new_job("post", "supers",  :update, usecase, :core)
-    leavers  = session.new_job("post", "leavers", :update, usecase, :account)
+    @creation = session.new_job("main", "create",  :create, usecase)
+    @update   = session.new_job("main", "update",  :update, usecase)
+    @supers   = session.new_job("post", "supers",  :update, usecase, :core)
+    @leavers  = session.new_job("post", "leavers", :update, usecase, :account)
 
     micro.with_each_leaver(entries, people, options) do |person|
-      leavers.add(person) do |person|
-        person.supervisor_id = nil
-        person.account       = nil if person.account
-      end
+      leavers.add(person, &method(:leavers_callback))
     end
 
     micro.with_each(entries, people, options) do |entry, person|
@@ -24,4 +23,11 @@ class Eco::API::UseCases::DefaultCases::HrisCase < Eco::API::Common::Loaders::Us
     end
   end
 
+  private
+
+  def leavers_callback(person)
+    person.supervisor_id = nil
+    person.account       = nil if person.account
+  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.rb

@@ -22,16 +22,17 @@ module Eco
 
     def run(session:)
       io = Eco::API::UseCases::BaseIO.new(session: session, options: options)
-      #session.workflow.run(io: io)
-      session.workflow(io: io) do |wf, io|
-        io = wf.run(:options, io: io)
-        io = wf.run(:load, io: io)
-        io = wf.run(:usecases, io: io)
-        io = wf.run(:launch_jobs, io: io)
-        io = wf.run(:post_launch, io: io)
-        io = wf.run(:end, io: io)
-        io = wf.run(:close, io: io)
-      end
+      session.workflow(io: io).run(io: io)
+      #session.workflow(io: io) do |wf, io|
+      #  io = wf.run(:options, io: io)
+      #  io = wf.run(:load, io: io)
+      #  io = wf.run(:usecases, io: io)
+      #  io = wf.run(:launch_jobs, io: io)
+      #  io = wf.run(:post_launch, io: io)
+      #  io = wf.run(:report, io: io)
+      #  io = wf.run(:end, io: io)
+      #  io = wf.run(:close, io: io)
+      #end
     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.9"
+  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.9
+  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