eco-helpers 2.0.11 → 2.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61ef9270db24cf1582814423b75bc1f3a74bf88cd14281862658c972d1f94f05
-  data.tar.gz: 30ac39b330426fcb8840b7e7456d240e6e7324030aea00b6950328708bbeb53b
+  metadata.gz: 669f1a3e8d49a2499b02d925386477a8e52cc633c830072420484edcf8e4919d
+  data.tar.gz: 86b36286a089bfa03d3cb17d4c17648a4dcc5f1ed07145ee81565cd19d102c90
 SHA512:
-  metadata.gz: 4dcfa4714c6b245c017194eb6b3fb623702472c260f5717b5485141fb9765fd7e10f891938e65978b7bc13142cc45e06efbc430db9cb63270355f6341e0991d3
-  data.tar.gz: 7cd4382209bef6d5b0db07b2adb90237500050b4ac9340ec39457f7f23d1131bc6562367bc5cf005fdcc4f3af1553dafd446aa02e551549b1bbb90c08e51e15d
+  metadata.gz: 0a346a01757374cc004c12b5aadadf6b3c1daebba937c8d1c0cf597608297ab825d604af3a7f70f92528e28e0f009fd482abd31eb660c4abcf9d9796f55f69db
+  data.tar.gz: f912a967dfb21cb0e455b357c9f5ca28fae4de55cbacd060fd000add64992b86168a3ed38150d1ddaf9a264245da582a49c434d62d24bc28285d82b3f9a2e693

data/CHANGELOG.md

@@ -1,11 +1,54 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.11] - 2021-03-xx
+## [2.0.16] - 2021-04-xx
 
 ### Added
+  - Use case `Eco::API::UseCases::DefaultCases::SupersCyclicIdentify`, invokable via `-identify-cyclic-supers`
+  - Use case `Eco::API::UseCases::DefaultCases::AbstractPolicyGroupAbilities`, invokable via `-abstract-policygroup-abilities`
+  - Option to run `one-off` scripts, without org configurations:
+    1. `-api-key INTERNAL_API_KEY`
+    2. `-enviro [live|pre.dev]`
+    3. `-org NAME_OF_ORG`
 
 ### Changed
+### Fixed
+
+
+## [2.0.15] - 2021-04-29
+
+### Added
+  - Use case `Eco::API::UseCases::DefaultCases::SupersHierarchy`, invokable via `-supers-hiearchy`
+### Fixed
+  - `eco/cli/config/default/workflow.rb` prevent `rescue` looping
+
+## [2.0.14] - 2021-04-15
+
+### 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
+
+### 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.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
@@ -25,34 +68,24 @@ All notable changes to this project will be documented in this file.
     - Ranamed `#defined_attrs` to `#defined_model_attrs`
     - Ranamed `#undefined_attrs` to `#undefined_model_attrs`
 
-### Fixed
-
 ## [2.0.9] - 2021-03-19
 
-### Added
 ### Changed
   - `Eco::API::Session::Batch:Errors#person_ref` moved to the public method
 
-### Fixed
-
 ## [2.0.8] - 2021-03-09
 
-### Added
-### Changed
 ### 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
@@ -60,46 +93,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
@@ -113,7 +133,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
 
@@ -135,11 +154,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`
 
@@ -155,23 +171,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.
 
@@ -180,14 +189,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.
@@ -195,15 +198,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
@@ -211,8 +210,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`
 
@@ -220,14 +217,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
@@ -368,14 +362,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`
@@ -385,22 +376,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
@@ -423,7 +409,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
 
@@ -431,33 +416,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
 
@@ -466,14 +442,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/eco-helpers.gemspec

@@ -36,5 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'aws-sdk-ses',   '>= 1.36.0', '< 2'
   spec.add_dependency 'dotenv',        '>= 2.7.6', '< 2.8'
   spec.add_dependency 'net-sftp',      '>= 3.0.0', '< 3.1'
-
+  #spec.add_dependency 'fuzzy_match'    '>= 2.1.0', '< 2.2'
 end

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

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

@@ -15,6 +15,7 @@ module Eco
             # Reorders as follows:
             #   1. supervisors, people with no supervisor or where their supervisor not present
             #   2. subordinates
+            # @return [Array<Entry>] `values` sorted by supervisors/subordinates
             def sort_by_supervisors(values, supervisors_first: true)
               raise "Expected non hash Enumerable. Given: #{values.class}" if values.is_a?(Hash)
               return [] unless values && values.is_a?(Enumerable)
@@ -32,6 +33,32 @@ module Eco
               roam.call(supervisors_tree(values))
             end
 
+            # Identifies all the cyclic supervisor chains
+            # @note as `supervisors_tree` will have any entry involved in a cycle at the top, it just checks all the top entries against their offspring
+            # @return [Array<Array>] the sets of entries that are cyclic
+            def identify_cyclic_chains(values)
+              raise "Expected non hash Enumerable. Given: #{values.class}" if values.is_a?(Hash)
+              return [] unless values && values.is_a?(Enumerable)
+
+              identify  = Proc.new do |top_sup, offspring, chain = [top_sup]|
+                next [] if offspring.empty?
+                offspring.each_with_object([]) do |(sup, subordinates), set|
+                  break set unless set.empty?
+                  if top_sup.supervisor_id == sup.id
+                    set.concat(chain, [sup])
+                  else
+                    set = identify.call(top_sup, subordinates, chain | [sup])
+                  end
+                end
+              end
+
+              supervisors_tree(values).each_with_object([]) do |(top_sup, offspring), sets|
+                if (set = identify.call(top_sup, offspring)) && !set.empty?
+                  sets.push(set)
+                end
+              end
+            end
+
             def tree_to_str(tree, lev: 0)
               raise "Required Hash tree structure. Given: #{tree.class}" unless tree.is_a?(Hash)
               "".tap do |str|

data/lib/eco/api/common/session/file_manager.rb

@@ -20,8 +20,8 @@ module Eco
             begin
               @dir = Eco::Data::Files::Directory.new(value)
               @dir_path = @dir.create
-            rescue
-              logger.error("could not create or make any sense of directory '#{value}'")
+            rescue Exception => e
+              logger.error("could not create or make any sense of directory '#{value}': #{e.to_s}")
             end
           end
 

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)