eco-helpers 2.0.14 → 2.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 697d71754e809691a39f62a86d5fc46e2988578c19c965945e1c06ea73b290b6
-  data.tar.gz: 01ef5ca1a9bcf941d44b5f7088f54dd9c2cba950cc562ed0516400811df60f12
+  metadata.gz: 14260868c76936513a93d4d104eacebbd11e47ed05806d4102ee76196a300d2b
+  data.tar.gz: 35784d03a18f89d2ce8bf5c4105e0eaa647dd10b4e1fee03897319d9ad838760
 SHA512:
-  metadata.gz: b24db6ddf741e3f0dcc3f080dba19132d7926c85cf211ae0f98c090c7a3cd93f513b6e977ac21ca24d5c2092d524cc1e7ef3d04250bb29ae672400623c823964
-  data.tar.gz: 9585e95676aab71322af2f174d06aed7d6226502bed1e2560cfd0915643e682c02fb857c33310f7c5f1b6d083b83267d14194f0f1e315c940048ef1c3c43faff
+  metadata.gz: 514d71e93bfa4fb854d9062be03306e154a4dfd184256ab03da30e2bf4bb2a45fb305efd5e2206821e522dc7cc0bfbc69e75285e3c6292dca78f359bd166f52a
+  data.tar.gz: c99a424905916cef61333c18bb31726e90fb9759a4a1b747b72ab123f4bc09ecc6962205a966b3ea46aa1f0a4cc3dd7f72a8c53829cc764a7993d64ad45495bf

data/CHANGELOG.md

@@ -1,7 +1,96 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.14] - 2021-03-xx
+## [2.0.19] - 2021-05-xx
+
+### Added
+  - Better error message for people searches & **offer** to select among the candidates:
+    - `Eco::API::Organization::People::MultipleSearchResults`, triggered from `Eco::API::Organization::People#find`
+    - `Eco::API::MicroCases#with_each` will offer the selection of candidates
+
+### Changed
+  - **renamed** and repurposed `Eco::API::Organization::PeopleAnalytics` to `PeopleSimilarity`
+
+### Fixed
+  - `Eco::Data::FuzzyMatch` adjustments for configuration propagation + some fixes
+  - Command option `-entries-from` can still be useful when used to obtain `-get-partial` of people base for `:export` use cases !!
+
+## [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)
+
+### 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
@@ -9,7 +98,6 @@ All notable changes to this project will be documented in this file.
   - `Eco::API::Organization::PresetsFactory` added integrity validation for `person_*` abilities
   - `Eco::API::Session::Batch::Job` more debug info on erron handlers
 
-### Changed
 ### Fixed
   - `Eco::API::Error.get_type` was almost always matching `Eco::API::Error::Unclassified` -> fixed
 

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

@@ -2,6 +2,10 @@ module Eco
   module API
     module Common
       module People
+        # TODO: EntryFactory should suppport multiple schemas itself
+        # => currently, it's through session.entry_factory(schema: id), but this is wrong
+        # => This way, Entries and PersonEntry will be able to refer to attr_map and person_parser linked to schema_id
+        # => "schema_id" should be an optional column in the input file, or parsable via a custom parser to scope the schema
         # Helper factory class to generate entries (input entries).
         # @attr_reader schema [Ecoportal::API::V1::PersonSchema] person schema to be used in this entry factory
         class EntryFactory < Eco::API::Common::Session::BaseSession
@@ -12,7 +16,7 @@ module Eco
           # @param schema [Ecoportal::API::V1::PersonSchema] schema of person details that the parser will be based upon.
           # @param person_parser [nil, Eco::API::Common::People::PersonParser] set of attribute, type and format parsers/serializers.
           # @param attr_map [nil, Eco::Data::Mapper] attribute names mapper to translate external names into internal ones and _vice versa_.
-          def initialize(e, schema:, person_parser: nil, attr_map: nil)
+          def initialize(e, schema:, person_parser: nil, default_parser: nil, attr_map: nil)
             fatal "Constructor needs a PersonSchema. Given: #{schema}" if !schema.is_a?(Ecoportal::API::V1::PersonSchema)
             fatal "Expecting PersonParser. Given: #{person_parser}"    if person_parser && !person_parser.is_a?(Eco::API::Common::People::PersonParser)
             fatal "Expecting Mapper object. Given: #{fields_mapper}"   if attr_map && !attr_map.is_a?(Eco::Data::Mapper)
@@ -22,14 +26,25 @@ module Eco
             @source_person_parser = person_parser
 
             # load default parser + custom parsers
-            base_parser = Eco::API::Common::People::DefaultParsers.new(schema: @schema).merge(@source_person_parser)
+            @default_parser = default_parser&.new(schema: @schema) || Eco::API::Common::People::DefaultParsers.new(schema: @schema)
+            base_parser = @default_parser.merge(@source_person_parser)
             # new parser with linked schema
             @person_parser = @source_person_parser.new(schema: @schema).merge(base_parser)
             @person_parser_patch_version = @source_person_parser.patch_version
-
             @attr_map = attr_map
           end
 
+          def newFactory(schema: nil)
+            self.class.new(
+              environment,
+              schema: schema,
+              person_parser: @source_person_parser,
+              default_parser: @default_parser,
+              attr_map: @attr_map
+            )
+          end
+
+
           # provides with a Eco::API::Common::People::PersonParser object (collection of attribute parsers)
           # @note if the custom person parser has changed, it updates the copy of this EntryFactory instance
           # @return [Eco::API::Common::People::PersonParser] set of attribute, type and format parsers/serializers.
@@ -43,7 +58,7 @@ module Eco
 
           # key method to generate objects of `PersonEntry` that share dependencies via this `EntryFactory` environment.
           # @note this method is necessary to make the factory object work as a if it was a class `PersonEntry` you can call `new` on.
-          # @param data [Array<Hash>] data to be parsed. The external hashed entry.
+          # @param data [Hash, Person] data to be parsed/serialized. Parsed: the external hashed entry. Serialized: a Person object.
           # @return [Eco::API::Common::People::PersonEntry]
           def new(data, dependencies: {})
             PersonEntry.new(
@@ -104,7 +119,7 @@ module Eco
           # @param format [Symbol] it specifies the format of the output `file:` (i.e. `:xml`, `:csv`). There must be a parser/serializer defined for it.
           # @param encoding [String] optional parameter to geneate `file:` content by unsing certain encoding.
           # @return [Void].
-          def export(data:, file: "export", format: :csv, encoding: "utf-8")
+          def export(data:, file: "export", format: :csv, encoding: "utf-8", internal_names: false)
             fatal("data: Expected Eco::API::Organization::People object. Given: #{data.class}") unless data.is_a?(Eco::API::Organization::People)
             fatal("A file should be specified.") unless !file.to_s.strip.empty?
             fatal("Format should be a Symbol. Given '#{format}'") if format && !format.is_a?(Symbol)
@@ -112,16 +127,18 @@ module Eco
 
             run = true
             if Eco::API::Common::Session::FileManager.file_exists?(file)
-              print "The file '#{file}' already exists. Do you want to overwrite it? (Y/n): "
-              res = STDIN.gets.strip
-              run = ["y", "Y", ""].include?(res)
+              prompt_user("The file '#{file}' already exists. Do you want to overwrite it? (Y/n):", default: "Y") do |response|
+                run = (response == "") || reponse.upcase.start_with?("Y")
+              end
             end
 
             if run
               deps = {"supervisor_id" => {people: data}}
 
               data_entries = data.map do |person|
-                self.new(person, dependencies: deps).external_entry
+                self.new(person, dependencies: deps).yield_self do |entry|
+                  internal_names ? entry.mapped_entry : entry.external_entry
+                end
               end
 
               File.open(file, "w", enconding: encoding) do |fd|

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

@@ -210,13 +210,13 @@ 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)
             end
           end
 
+          # TO DO: use person.details.schema_id to switch @emap and @person_parser (or just crash if they don't match?)
           # Setter to fill in all the schema `details` fields of the `Person` that are present in the `Entry`.
           # @note it only sets those details properties defined in the entry.
           #  Meaning that if an details property is not present in the entry, this will not be set on the target person.
@@ -290,7 +290,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.rb

@@ -13,4 +13,5 @@ require_relative 'session/sftp'
 require_relative 'session/s3_uploader'
 require_relative 'session/file_manager'
 require_relative 'session/environment'
+require_relative 'session/helpers'
 require_relative 'session/base_session'

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

@@ -11,6 +11,8 @@ module Eco
           attr_reader  :api, :file_manager, :logger
           alias_method :fm, :file_manager
 
+          include Session::Helpers
+          
           def initialize(e)
             raise "Expected object Eco::API::Common::Session::Environment. Given: #{e.class}" unless e.is_a?(Environment)
             self.environment = e

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

@@ -0,0 +1,30 @@
+require_relative 'helpers/prompt_user'
+
+module Eco
+  module API
+    module Common
+      module Session
+        module Helpers
+
+          class << self
+            def included(base)
+              base.send(:include, InstanceMethods)
+              base.extend(ClassMethods)
+            end
+          end
+
+
+          module ClassMethods
+
+          end
+
+          module InstanceMethods
+            include Helpers::PromptUser
+            
+          end
+
+        end
+      end
+    end
+  end
+end