eco-helpers 2.0.16 → 2.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 669f1a3e8d49a2499b02d925386477a8e52cc633c830072420484edcf8e4919d
-  data.tar.gz: 86b36286a089bfa03d3cb17d4c17648a4dcc5f1ed07145ee81565cd19d102c90
+  metadata.gz: 4d982e3f0bdb6c5831544cc5a1e232f4d0902220adf9bf65dac88b64eee97d08
+  data.tar.gz: 0cc1d65f0336bef75df0f99cd972a99e5c986307fcb9e14bb3a7a3e5eef69173
 SHA512:
-  metadata.gz: 0a346a01757374cc004c12b5aadadf6b3c1daebba937c8d1c0cf597608297ab825d604af3a7f70f92528e28e0f009fd482abd31eb660c4abcf9d9796f55f69db
-  data.tar.gz: f912a967dfb21cb0e455b357c9f5ca28fae4de55cbacd060fd000add64992b86168a3ed38150d1ddaf9a264245da582a49c434d62d24bc28285d82b3f9a2e693
+  metadata.gz: 72b1e364f326a3d6e7fb0145ff8e4727bc41da1ae9f453be7d2aeec1c749e0b4463750cbe95370a5f241794d394ab79f3836339369ea6be131f2ebc18d7287ca
+  data.tar.gz: be3e03507f60c643a0b4d14eeca65f7a34534042a86a06239f9a015e9a2e8be6e2a757d1dfc94c7608663e53e503d6e0cc8bc9ffebe4ac54df8391be422df6a6

data/CHANGELOG.md

@@ -1,7 +1,55 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.16] - 2021-04-xx
+## [2.0.17] - 2021-05-24
+
+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`
@@ -11,14 +59,10 @@ All notable changes to this project will be documented in this file.
     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`
+  - Use case `Eco::API::UseCases::DefaultCases::SupersHierarchy`, invokable via `-supers-hierarchy`
 ### Fixed
   - `eco/cli/config/default/workflow.rb` prevent `rescue` looping
 

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 '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,7 @@
 require 'csv'
 require 'json'
 require 'pp'
+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

@@ -210,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)
@@ -290,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/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/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

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

@@ -21,9 +21,9 @@ module Eco
 
         start = Time.now
         entries = session.batch.get_people(people, silent: true)
-        secs    = Time.now - start
+        secs    = (Time.now - start).round(3)
         cnt     = entries.count
-        per_sec = (cnt.to_f / secs).floor
+        per_sec = (cnt.to_f / secs).round(2)
         logger.info("Re-loaded #{cnt} people (out of #{people.length}) in #{secs} seconds (#{per_sec} people/sec)")
 
         missing = people.length - entries.length

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

@@ -14,10 +14,10 @@ module Eco
 
         start = Time.now
         people = session.batch.search(data, silent: silent).yield_self do |status|
-          secs    = Time.now - start
+          secs    = (Time.now - start).round(3)
           Eco::API::Organization::People.new(status.people).tap do |people|
             cnt     = people.count
-            per_sec = (cnt.to_f / secs).floor
+            per_sec = (cnt.to_f / secs).round(2)
             msg     = "... could get #{cnt} people (out of #{data.length} entries) in #{secs} seconds (#{per_sec} people/sec)"
             session.logger.info(msg)
           end
@@ -29,10 +29,10 @@ module Eco
           session.logger.info("  Going to api get #{supers.length} current supervisors...")
           start = Time.now
           people = session.batch.search(supers, silent: silent).yield_self do |status|
-            secs    = Time.now - start
+            secs    = (Time.now - start).round(3)
             found   = status.people
             cnt     = found.count
-            per_sec = (cnt.to_f / secs).floor
+            per_sec = (cnt.to_f / secs).round(2)
             msg     = "... could find #{cnt} current supers (out of #{supers.length}) in #{secs} seconds (#{per_sec} people/sec)"
             session.logger.info(msg)
             people.merge(found, strict: micro.strict_search?(options))
@@ -46,10 +46,10 @@ module Eco
           start = Time.now
 
           people = session.batch.search(supers, silent: silent).yield_self do |status|
-            secs    = Time.now - start
+            secs    = (Time.now - start).round(3)
             found   = status.people
             cnt     = found.count
-            per_sec = (cnt.to_f / secs).floor
+            per_sec = (cnt.to_f / secs).round(2)
             msg     = "... could find #{cnt} input supers (out of #{supers.length}) in #{secs} seconds (#{per_sec} people/sec)"
             session.logger.info(msg)
             people.merge(found, strict: micro.strict_search?(options))

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

@@ -0,0 +1,23 @@
+module Eco
+  module API
+    class MicroCases
+      # Helper to preserve the original `default_tag`.
+      # @note
+      #   1. It only works if the original value of `default_tag` was **not** empty
+      # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
+      # @param options [Hash] the options.
+      # @return [String] the final value of `default_tag`.
+      def preserve_default_tag(person, options)
+        if account = person.account
+          if account.as_update.key?("default_tag")
+            if original = person.original_doc.dig("account", "default_tag")
+              person.account.default_tag = original
+            end
+          end
+        end
+        person.account&.default_tag
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Eco
+  module API
+    class MicroCases
+      # Helper to preserve the original filter tags.
+      # @note
+      #   1. It only works if the original value of `filter_tags` was **not** empty
+      # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
+      # @param options [Hash] the options.
+      # @param keep_new [Boolean] tells if it should keep the new tags or get rid of them.
+      # @return [Array<String>] the final value of `filter_tags`.
+      def preserve_filter_tags(person, options, keep_new: false)
+        if person.as_update.key?("filter_tags")
+          if original  = person.original_doc["filter_tags"]
+            unless original.empty?
+              if keep_new
+                person.filter_tags += original
+              else
+                person.filter_tags  = original
+              end
+            end
+          end
+        end
+        person.filter_tags
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Eco
+  module API
+    class MicroCases
+      # Helper to preserve the original `policy_group_ids`.
+      # @note
+      #   1. It only works if the original value of `policy_group_ids` was **not** empty
+      # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
+      # @param options [Hash] the options.
+      # @param keep_new [Boolean] tells if it should keep the new policy groups or get rid of them.
+      # @return [String] the final value of `policy_group_ids`.
+      def preserve_policy_groups(person, options, keep_new: false)
+        if account = person.account
+          if account.as_update.key?("policy_group_ids")
+            if original = person.original_doc.dig("account", "policy_group_ids")
+              unless original.empty?
+                if keep_new
+                  person.account.policy_group_ids += original
+                else
+                  person.account.policy_group_ids  = original
+                end
+              end
+            end
+          end
+        end
+        person.account&.policy_group_ids
+      end
+
+    end
+  end
+end