eco-helpers 2.0.12 → 2.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3506fbbcb2da4707ebb9451ea0f4afe1549923a4af2aed306d929243a94016df
-  data.tar.gz: 5279c8a96662b19c097cb9d2e0a35b2d29ccb917ec77873ff0fb248b83d51069
+  metadata.gz: 4d982e3f0bdb6c5831544cc5a1e232f4d0902220adf9bf65dac88b64eee97d08
+  data.tar.gz: 0cc1d65f0336bef75df0f99cd972a99e5c986307fcb9e14bb3a7a3e5eef69173
 SHA512:
-  metadata.gz: 5100d854ec4b3ca20f8127d4128325ad8e557d554167917af7d495761da81f2e21be2f45b33dd00b02d1d7f830299f1bcde6e88134db62b021ddef6c7a234f88
-  data.tar.gz: d65ef75ed11d804ee4d45768533c8d4ccef60c88fc435dc6d9df909d87f962a7914036e110cf8c4231b53b1738c85369458ca2e464dc7efefce3e3760a9d4c04
+  metadata.gz: 72b1e364f326a3d6e7fb0145ff8e4727bc41da1ae9f453be7d2aeec1c749e0b4463750cbe95370a5f241794d394ab79f3836339369ea6be131f2ebc18d7287ca
+  data.tar.gz: be3e03507f60c643a0b4d14eeca65f7a34534042a86a06239f9a015e9a2e8be6e2a757d1dfc94c7608663e53e503d6e0cc8bc9ffebe4ac54df8391be422df6a6

data/CHANGELOG.md

@@ -1,21 +1,98 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.12] - 2021-03-29
+## [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
-  - `Eco::CLI#run` it does include any defined states on the workflow
+  - 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
 
-## [2.0.11] - 2021-03-29
+### 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`
+
+### 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
@@ -35,34 +112,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
@@ -70,46 +137,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
@@ -123,7 +177,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
 
@@ -145,11 +198,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`
 
@@ -165,23 +215,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.
 
@@ -190,14 +233,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.
@@ -205,15 +242,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
@@ -221,8 +254,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`
 
@@ -230,14 +261,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
@@ -378,14 +406,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`
@@ -395,22 +420,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
@@ -433,7 +453,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
 
@@ -441,33 +460,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
 
@@ -476,14 +486,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

@@ -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,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/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/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