eco-helpers 2.0.13 → 2.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 726f5a5930889b9fd59b4acc4ce7b938e3c6011909c2f5a5bb1a105a36df4d9b
-  data.tar.gz: 804bc3ae796491543ec3615e9f11308333e7ea6fc9a10f943778f66922aa4a25
+  metadata.gz: 678fc1c610a5aafd8321a74367a6aaca67aa70bf159f638209b45da0361bb575
+  data.tar.gz: 280a74a3a3877c5d58bfbe84d0f6a8f8b6f8eda5c68f376fea87522b03a59e42
 SHA512:
-  metadata.gz: f2e1c852b4660ae1bdc3e94bab274f3d4b7168c6affef57315b370af102b71cff19cdb0c2de0b59899f82b7f2f8b0478688cf018f3c52f26c1f1d891ed19cd65
-  data.tar.gz: 032a93267eb45f7550fbdad7805d0f472a0ea1a98353b089147bd71de785cdeaa4933b233bdd22d4ab69f7a85bfa65ec1f0850fe82e446dcf4d5f503ba1f191b
+  metadata.gz: 30c74c7aa8b7f59a4610cb4da804714a165a095d6280b756dcec17df37a81f2b5438a7178cc279750e5f97a43ae6d0041e464d9ed7965af39c39fc71ce4efc99
+  data.tar.gz: 1abe7f74b0a0452565c1add7778086030372f63912fe2c6279a2d40eb9f908d07746421507241d4905bbdf546e944899fa0f63fa3e3fe086caf1663c83a2624d

data/CHANGELOG.md

@@ -1,14 +1,99 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.0.18] - 2021-05-25
+
+### Added
+  - **`-one-off`** option to not having to type the `-api-key` every time you launch one-off scripts
+    - `-api-key` will store the key to the `./.env_one_off` file (supports update and multi-environment)
+
+### Changed
+### Fixed
+  - patched `Exception#patch_full_message` to do not enter into a cyclic error rescue
+  - also rescue on `workflow.rescue`
+
+## [2.0.17] - 2021-05-25
+
+Specific changes due to eP **release `1.5.9.70`** (_Policy Group Abilities_)
+  - And some improvements as well as new tools
+
+### Added
+  - `Eco::API::Organization::PresetsFactory` added integrity validation for `person_abilities` ability
+  - `Eco::API::Organization::PresetsFactory`
+    - `#validate`: returns an `Array` with all the errors that a `permissions_custom` has
+    - `#valid?`: checks if a `permissions_custom` is valid
+  - `Eco::API::Organization::PeopleAnalytics`: a **helper** class to identify things in the People Manager and provide mitigation action methods to resolve them.
+    - Added dependencies to `fuzzy_match`, `amatch` and `jaro_winkler` **gems**
+    - `Eco::Data::FuzzyMatch` with string match helpers and a set of home-made generic libs.
+    - `Eco::API::Organization::PeopleAnalytics` to launch analysis on the People Manager
+      - `Eco::API::UseCases::DefaultCases::AnalysePeople` invokable via `-analyse-people`
+  - **new** -> a way to define a hierarchy of options (at least of 1 Level)
+    - `API::CLI::Config::OptionsSet`
+    - `API::CLI::Config::UseCases::CaseConfig`
+    - Integrated the new feature to the `--help` command and methods.
+  - **Usecase** `Eco::API::UseCases::DefaultCases::ResetLandingPageCase` added parameter to specify `-page-id`
+  - `Eco::API::Common::BaseLoader` new shortcut methods `#micro` (_MicroCases_), `#session` and `#config`
+    - At this stage of the execution workflow it uses `ASSETS.session`
+    - **Important note**: when the `#parser` or `#serializer` are called the `ASSETS.session` might already be linked to the specific invoked environment
+  - New method helpers in `Ecoporta::API::MicroCases`
+    - `preserve_filter_tags`, `preserve_default_tag` and `preserve_policy_groups`
+
+### Changed
+  - upgraded dependency on `ecoportal-api` and `ecoportal-api-v2`
+  - **removed** `Eco::API::MicroCases#refresh_abilities`
+    - `Eco::API::MicroCases#set_account` **removed** `refresh_abilities`
+    - `Eco::API::MicroCases#append_usergroups` **removed** `refresh_abilities`
+    - **removed** _usecase_ `Eco::API::UseCases::DefaultCases::RefreshAbilitiesCase` (`-refresh-abilities`)
+  - `Eco::API::Policies::DefaultPolicies::UserAccess`: **removed** `refresh_abilities`
+  - **removed** `Eco::API::Session#new_preset`
+  - `Eco::API::Organization::PresetsFactory`
+    - **removed** `rspecs`
+    - `.new`: **removed** parameters `presets_custom` & `presets_map`
+    - **removed** constants `DEFAULT_CUSTOM`, and `DEFAULT_MAP`
+    - **removed** private methods `#presets_custom` and `#presets_map`
+    - **changed** private method `#compile` receives directly an array of `permissions_custom`
+  - `Eco::API::Session::Config` **removed** methods `#presets_custom=` & `presets_map=`
+    - `Eco::API::Session::Config::People` **removed** methods `#presets_custom=`, `#presets_map=`,`#presets_custom` & `#presets_map`
+  - **removed** `eco/api/organization/presets_reference.json`
+  - **moved** case-specific options to only be active when the user case is previously invoked in the command line.
+
+### Fixed
+  - **handle** `Ecoportal::API:Errors::TimeOut` in `Eco::API::Session::Batch` by offering to retry.
+
+## [2.0.16] - 2021-05-04
+
+### 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`
+
+## [2.0.15] - 2021-04-29
+
+### Added
+  - Use case `Eco::API::UseCases::DefaultCases::SupersHierarchy`, invokable via `-supers-hierarchy`
+### 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`
 
-### Changed
-
 ### Fixed
   - Ensure auto-loading for `Eco::API::UseCases`
 

data/eco-helpers.gemspec

@@ -24,17 +24,19 @@ Gem::Specification.new do |spec|
   #spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",   ">= 2.2.11",  "< 2.3"
+  spec.add_development_dependency "bundler",   ">= 2.2.17",  "< 2.3"
   spec.add_development_dependency "rspec",     ">= 3.10.0", "< 3.11"
   spec.add_development_dependency "rake",      ">= 13.0.3", "< 13.1"
   spec.add_development_dependency "yard",      ">= 0.9.26", "< 0.10"
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
 
-  spec.add_dependency 'ecoportal-api', '>= 0.8.2', '< 0.9'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.6', '< 0.9'
+  spec.add_dependency 'ecoportal-api', '>= 0.8.3', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.7', '< 0.9'
   spec.add_dependency 'aws-sdk-s3',    '>= 1.83.0', '< 2'
   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'
+  spec.add_dependency 'amatch',        '>= 0.4.0', '< 0.5'
+  spec.add_dependency 'jaro_winkler',  '>= 1.5.4', '< 1.6'
 end

data/lib/eco-helpers.rb

@@ -1,6 +1,8 @@
 require 'csv'
 require 'json'
 require 'pp'
+require 'dotenv'
+require 'dotenv/load'
 
 
 module Eco

data/lib/eco/api/common/base_loader.rb

@@ -48,6 +48,20 @@ module Eco
           self.class.name
         end
 
+        private
+
+        def session
+          @session ||= ASSETS.session
+        end
+
+        def micro
+          session.micro
+        end
+
+        def config
+          @config ||= ASSETS.config
+        end
+
       end
     end
   end

data/lib/eco/api/common/people/default_parsers/date_parser.rb

@@ -6,7 +6,7 @@ class Eco::API::Common::People::DefaultParsers::DateParser < Eco::API::Common::L
   end
 
   def serializer(value, deps)
-    value.is_a?(Array) ? value.map { |d| d && d.strftime('%Y-%m-%d') } : value && value.strftime('%Y-%m-%d')
+    value.is_a?(Array) ? value.map { |d| serialize_date(d) } : serialize_date(value)
   end
 
   private
@@ -19,4 +19,14 @@ class Eco::API::Common::People::DefaultParsers::DateParser < Eco::API::Common::L
     end
   end
 
+  def serialize_date(value)
+    return value if value.is_a?(String)
+    begin
+      value && value.strftime('%Y-%m-%d')
+    rescue
+      nil
+    end
+  end
+
+
 end

data/lib/eco/api/common/people/default_parsers/login_providers_parser.rb

@@ -20,7 +20,7 @@ class Eco::API::Common::People::DefaultParsers::LoginProvidersParser < Eco::API:
   private
 
   def login_providers
-    @login_providers ||= ASSETS.config.login_providers
+    @login_providers ||= config.login_providers
   end
 
 end

data/lib/eco/api/common/people/default_parsers/policy_groups_parser.rb

@@ -1,31 +1,31 @@
 class Eco::API::Common::People::DefaultParsers::PolicyGroupsParser < Eco::API::Common::Loaders::Parser
   attribute "policy_group_ids"
+  parsing_phase     :final
 
   def parser(hash, deps)
-    policy_group_ids = []
-    if policy_ids = hash["policy_group_ids"]
-      policy_group_ids = policy_ids.split("|").map do |name|
-        policy_groups.to_id(name&.downcase.strip)
-      end.compact
+    policy_group_ids = hash["policy_group_ids"] || []
+    policy_group_ids.map do |name|
+      policy_groups.to_id(name&.downcase.strip)
+    end.compact.tap do |pg_names|
+      pg_names.push(default_id) if pg_names.empty?
     end
-    policy_group_ids.empty?? default_id : policy_group_ids.join("|")
   end
 
   def serializer(person, deps)
     ids   = person&.account&.policy_group_ids || []
     ids.map do |id|
       policy_groups.to_name(id)
-    end.compact.join("|")
+    end.compact
   end
 
   private
 
-  def policy_groups
-    @policy_groups ||= ASSETS.config.policy_groups
+  def default_id
+    @default_id    ||= policy_groups.to_id(config.people.default_usergroup)
   end
 
-  def default_id
-    @default_id    ||= policy_groups.to_id(ASSETS.config.people.default_usergroup)
+  def policy_groups
+    @policy_groups ||= config.policy_groups
   end
 
 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
@@ -205,7 +210,6 @@ module Eco
           # @param exclude [String, Array<String>] account properties that should not be set/changed to the person.
           def set_account(person, exclude: nil)
             person.account = {} if !person.account
-            person.account.permissions_preset = nil unless person.account.permissions_preset = "custom"
             scoped_attrs = @emap.account_attrs - into_a(exclude)
             @final_entry.slice(*scoped_attrs).each do |attr, value|
               set_part(person.account, attr, value)
@@ -285,7 +289,10 @@ module Eco
           # @param internal_entry [Hash] entry with **internal** names and values, but **external** types.
           # @return [Hash] entry with **internal** names and **external** values and types.
           def _mapped_serializing(internal_entry)
-            internal_entry.merge(_serialize_values(internal_entry, :internal))
+            mapped_hash = internal_entry.merge(_serialize_values(internal_entry, :internal))
+            model_attrs = @person_parser.all_model_attrs - ["send_invites"]
+            aux_hash    = mapped_hash.slice(*model_attrs)
+            merge_missing_attrs(aux_hash, mapped_hash)
           end
 
           # Parsing helper that just **parses the values** that have a parser/serializer defined.

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

@@ -1,5 +1,4 @@
 require 'aws-sdk-ses'
-require 'dotenv/load'
 
 module Eco
   module API

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

@@ -1,5 +1,4 @@
 require 'aws-sdk-s3'
-require 'dotenv/load'
 
 module Eco
   module API

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

@@ -1,5 +1,4 @@
 require "net/sftp"
-require 'dotenv/load'
 
 module Eco
   module API

data/lib/eco/api/common/version_patches/exception.rb

@@ -1,9 +1,13 @@
 class ::Exception
   def patch_full_message
-    msg = []
-    msg << "\n#{backtrace.first} \n#{message} (#{self.class.to_s})"
-    backtrace[1..-1].each_with_index {|bt, i| msg << "#{" "*8}#{i+1}: from #{bt}"}
-    msg.join("\n")
+    begin
+      msg = []
+      msg << "\n#{backtrace.first} \n#{message} (#{self.class.to_s})"
+      backtrace[1..-1].each_with_index {|bt, i| msg << "#{" "*8}#{i+1}: from #{bt}"}
+      msg.join("\n")
+    rescue Exception => e
+      puts "Something is wrong with 'patch_full_message': #{e}"
+    end
   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)

data/lib/eco/api/microcases.rb

@@ -19,7 +19,9 @@ require_relative 'microcases/people_cache'
 require_relative 'microcases/people_load'
 require_relative 'microcases/people_refresh'
 require_relative 'microcases/people_search'
-require_relative 'microcases/refresh_abilities'
+require_relative 'microcases/preserve_filter_tags'
+require_relative 'microcases/preserve_default_tag'
+require_relative 'microcases/preserve_policy_groups'
 require_relative 'microcases/set_account'
 require_relative 'microcases/set_core_with_supervisor'
 require_relative 'microcases/set_core'

data/lib/eco/api/microcases/append_usergroups.rb

@@ -9,7 +9,6 @@ module Eco
         unless options.dig(:exclude, :account)
           if person.account
             person.account.policy_group_ids |= entry.policy_group_ids
-            micro.refresh_abilities(person, options)
           end
         end
       end

data/lib/eco/api/microcases/people_cache.rb

@@ -9,9 +9,9 @@ module Eco
 
         start = Time.now
         people = session.batch.get_people
-        secs    = Time.now - start
+        secs    = (Time.now - start).round(3)
         cnt     = people.count
-        per_sec = (cnt.to_f / secs).floor
+        per_sec = (cnt.to_f / secs).round(2)
         logger.info("Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)")
 
         file   = file_manager.save_json(people, filename, :timestamp)

data/lib/eco/api/microcases/people_load.rb

@@ -34,9 +34,9 @@ module Eco
 
           start = Time.now
           session.batch.get_people.tap do |people|
-            secs    = Time.now - start
+            secs    = (Time.now - start).round(3)
             cnt     = people.count
-            per_sec = (cnt.to_f / secs).floor
+            per_sec = (cnt.to_f / secs).round(2)
             logger.info("Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)")
 
             if modifier.include?(:save) && people && people.length > 0