eco-helpers 2.0.57 → 2.0.60

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f311bacb1d039da9637ae6eb6fc33f709aef06e6647591a6f9dd981d010a424
-  data.tar.gz: fe3056df3a19353c4b915440f3ba26bb181e8b89aa8570e4a356b8aa926e71b7
+  metadata.gz: 182922a2146b1fa50b0372253a5279eb7d801c4fabd8fcd5303dd6322091c91c
+  data.tar.gz: 5f807f72bc3b6fc7a376bbd43d7a10b99cb5144a606ded5f9eb6817b82740788
 SHA512:
-  metadata.gz: b0a0506303240b5a3e7f1b52865cbf142d2b50a4adbd64ab062f607df73502c49ecf37df659fc549676922740f118cfbcf0abf336876ba49423cf8c087ff04a5
-  data.tar.gz: 2f5b1775eb19b2c8ed4ebf4539e06418fae5d5c0b969d9ee5f24f65a66fe8819162023e76a60409d63ac9869649dec35713981604b66e15097ea41ec47a4f3af
+  metadata.gz: 40cb65992b4c9524e025b7f7073f699062cd22008202491c593089b662c9b72ac611eb9cfcccfe14a2f62e1d519eb5dad14fef9389b6e2cbee1798ced0baa54f
+  data.tar.gz: 3e3154fcf629162a1445acbafd96f2d00f8d2a84f77bfb9b2cb68ce6c7f36ed4e8f5fea3cee43e897ac1b50b0210fd14bf9489b0a6708a6bc954093a7b1af3f8

data/CHANGELOG.md

@@ -1,17 +1,57 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.57] - 2022-04-xx
+## [2.0.60] - 2022-06-xx
 
 ### Added
+### Changed
+### Fixed
+  - `Ecoportal::API::V1::PersonDetails.key?` patched
+  
+## [2.0.59] - 2022-06-07
+
+### Added
+  - `Eco::API::Organization::TagTree#leafs` new method to spot tags with no children.
 
 ### Changed
-  - `Eco::API::UseCases::DefaultCases::HrisCase`
-    - Made it so the `leavers` batch runs first
-    - This aims to prevent some errors such as `cyclic supervisor` or `email already taken`
+  - `Eco::API::MicroCases#core_excluded`
+    - when person is `new?`, you should still be able to exclude `filter_tags`
+
+### Fixed
+  - `Eco::API::Policies::DefaultPolicies::UserAccess`
+    - `-exclude-account` should leave it untouched
+
+## [2.0.58] - 2022-05-31
+
+### Added
+  - **Usecase**`Eco::API::UseCases::DefaultCases::ClearAbilitiesTransCase`
+    - invokable with `clear-abilities`
+  - `Eco::API::Session::Config::People` added
+    - `default_login_method` helpers
+  - `Eco::API::Session::Config#default_login_method=` added
+  - `Eco::API::Common::Loaders::Base#abort` method to log an error and raise an exception
+  - **patched** `Ecoportal::API::Internal::Person`
+    - Added a couple of handy helpers: `#replace_doc` and `#replace_original_doc`
+
+### Changed
+  - `Eco::API::Common::Session::SFTP#move` new parameter `override:` (default: `true`)
+    - If there was an error, it would delete the destination remote file and retry to move the file
+    - upgraded `ecoportal-api-v2` gem to `0.8.28`
+  - `Eco::API::Organization::LoginProviders#login_provider`
+    - Added support to fetch based on type (i.e. password, sso)
+  - `Eco::API::Policies::DefaultPolicies::UserAccess`
+    - Added support for `config.default_login_method`
 
 ### Fixed
+  - `Eco::API::Common::People::EntryFactory`
+    - Max allowed enconding errors was not working (it was just fixing all).
+
+## [2.0.57] - 2022-04-29
 
+### Changed
+  - `Eco::API::UseCases::DefaultCases::HrisCase`
+    - Made it so the `leavers` batch runs first
+    - This aims to prevent some errors such as `cyclic supervisor` or `email already taken`
 
 ## [2.0.56] - 2022-04-25
 
@@ -43,7 +83,6 @@ All notable changes to this project will be documented in this file.
 ### Added
   - `Eco::API::UseCases::DefaultCases::Samples::Sftp` should tell where the files went in the local.
 
-
 ## [2.0.53] - 2022-04-04
 
 ### Added

data/eco-helpers.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
 
   spec.add_dependency 'ecoportal-api', '>= 0.8.5', '< 0.9'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.27', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.28', '< 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'

data/lib/eco/api/common/loaders/base.rb

@@ -51,6 +51,14 @@ module Eco
             session.micro
           end
 
+          def abort(msg, raising: true)
+            logger.error(msg)
+            if raising
+              raise msg
+            else
+              exit(1)
+            end
+          end
         end
       end
     end

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

@@ -11,7 +11,7 @@ class Eco::API::Common::People::DefaultParsers::BooleanParser < Eco::API::Common
 
   private
 
-  def truthy (value)
+  def truthy(value)
     %w[true y yes x].include?(value.to_s.strip.downcase)
   end
 

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

@@ -208,6 +208,7 @@ module Eco
                   logger.error("There were more than 5 encoding errors in the file '#{file}'.")
                   return content
                 else
+                  tolerance -= 1
                   logger.error("Encoding problem in file '#{file}': '#{replacement}'.")
                   replacement
                 end

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

@@ -56,8 +56,14 @@ module Eco
           end
 
           # @see Net::SFTP::Session#rename
-          def move(fullname_source, fullname_dest, flags=0x0001, &callback)
-            sftp_session.rename!(fullname_source, fullname_dest, flags, &callback)
+          def move(fullname_source, fullname_dest, flags=0x0001, override: true, &callback)
+            begin
+              sftp_session.rename!(fullname_source, fullname_dest, flags, &callback)
+            rescue Net::SFTP::StatusException => e
+              raise unless override
+              sftp_session.remove(fullname_dest)
+              sftp_session.rename!(fullname_source, fullname_dest, flags, &callback)
+            end
           end
 
           # Downloads the files specified to a local folder

data/lib/eco/api/common/version_patches/ecoportal_api/external_details.rb

@@ -0,0 +1,15 @@
+module Ecoportal
+  module API
+    class V1
+      class PersonDetails
+        # Checks if an `id` or `alt_id` exists
+        # @param id [String] the `id` or the `alt_id` of the target field.
+        # @return [Boolean] `true` if it exists, `false` otherwise
+        def key?(id)
+          @fields_by_id or index_fields
+          @fields_by_id.key?(id) || @fields_by_alt_id.key?(id)
+        end        
+      end
+    end
+  end
+end

data/lib/eco/api/common/version_patches/ecoportal_api/internal_person.rb

@@ -14,6 +14,23 @@ module Ecoportal
           account && !ref_doc["account"]
         end
 
+        # It replaces `doc` by `new_doc`
+        # @return [Hash] `doc` before change
+        def replace_doc!(new_doc)
+          raise UnlinkedModel.new(from: "#{self.class}#replace_doc", key: _key) unless linked?
+          @doc.tap do
+            @doc = new_doc
+          end
+        end
+
+        # It replaces `original_doc` by `new_doc`
+        # @return [Hash] `original_doc` before change
+        def replace_original_doc!(new_doc)
+          raise UnlinkedModel.new(from: "#{self.class}#replace_original_doc", key: _key) unless linked?
+          @original_doc.tap do
+            @original_doc = new_doc
+          end
+        end
       end
     end
   end

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

@@ -1,2 +1,3 @@
 require_relative 'ecoportal_api/external_person'
+require_relative 'ecoportal_api/external_details'
 require_relative 'ecoportal_api/internal_person'

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

@@ -7,12 +7,11 @@ module Eco
       # @return [Array<String>] the core parameters that should not be included.
       def core_excluded(person, options)
         ["supervisor_id"].tap do |core_excluded|
-          unless person.new?
-            exclusions = ["name", "external_id", "email", "filter_tags"].select do |attr|
-              options.dig(:exclude, attr.to_sym)
-            end
-            core_excluded.concat(exclusions)
+          can_exclude = person.new?? ["filter_tags"] : ["name", "external_id", "email", "filter_tags"]
+          exclusions  = can_exclude.select do |attr|
+            options.dig(:exclude, attr.to_sym)
           end
+          core_excluded.concat(exclusions)
         end
       end
     end

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

@@ -3,7 +3,7 @@ module Eco
     class MicroCases
       # Unique access point to set the `supervisor_id` value on a person.
       # @note
-      #   - It prevents the basic cyclic supervisor case (supervisor to be supervisor of hemselves)
+      #   - It prevents the basic cyclic supervisor case (supervisor to be supervisor of themselves)
       # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
       # @param sup_id [nil, String] the **supervisor id** we should set on the `person`.
       # @param people [Eco::API::Organization::People] _People_ involved in the current update.

data/lib/eco/api/organization/login_providers.rb

@@ -56,27 +56,41 @@ module Eco
           end
         end
 
-        def login_provider(id_name)
-          @by_id.fetch(login_provider_id(id_name), nil)
+        # @param id_name_type [String, Symbol]
+        #   - `String` to refer to the login provider `name` or `id`
+        #   - `Symbol` to refer to the login providr type (i.e. `:password`, `:sso`)
+        def login_provider(id_name_type)
+          @by_id[login_provider_id(id_name_type)]
         end
 
         private
 
-        def login_provider_name(id_name)
-          (@by_id[id_name] || @by_name[id_name&.downcase])&.name&.downcase
-        end
-
-        def login_provider_id(id_name)
-          (@by_name[id_name&.downcase] || @by_id[id_name])&.id
+        def login_provider_id(value)
+          case value
+          when Symbol
+            value = value.to_s.downcase.to_sym
+            @by_type[value]&.id
+          when String
+            value = value.strip.downcase
+            @by_name[value]&.id || @by_id[value]&.id
+          end
         end
 
         def init_caches
           return if @caches_init
-          @by_id   = self.map { |pg| [pg.id, pg] }.to_h
-          @by_name = self.map { |pg| [pg.name&.downcase, pg] }.to_h
+          enabled_lps = self.select {|lp| lp.enabled_for != "disabled"}
+          @by_id   = enabled_lps.each_with_object({}) do |lp, hash|
+            hash[lp.id.downcase] = lp
+          end
+          @by_name = enabled_lps.each_with_object({}) do |lp, hash|
+            hash[lp.name.downcase] = lp
+          end
+          @by_type = enabled_lps.each_with_object({}) do |lp, hash|
+            hash[lp.type.downcase.to_sym] = lp
+            hash[:sso] = lp if (!hash.key?(:sso) && lp.type == "saml")
+          end
           @caches_init = true
         end
-
       end
     end
   end

data/lib/eco/api/organization/tag_tree.rb

@@ -124,6 +124,14 @@ module Eco
           subtags.include?(key&.upcase)
         end
 
+        # Returns all the tags with no children
+        # @return [Array<String>]
+        def leafs
+          tags.select do |tag|
+            node(tag).children_count == 0
+          end
+        end
+
         # Verifies if a tag exists in the tree.
         # @param key [String] tag to verify.
         # @return [Boolean]

data/lib/eco/api/policies/default_policies/99_user_access_policy.rb

@@ -1,3 +1,7 @@
+# Default policy:
+# 1. Removes the account if the email is empty
+# 2. Adds the defined default_usergroup if user does not have policy groups
+# 3. Adds the defined default_login_method if update includes empty login methods
 class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loaders::Policy
   name "default-user-access"
 
@@ -10,8 +14,13 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
     self.account_removed_count = 0
 
     people.each do |person|
-      remove_account_when_no_email!(person)    if person.email.to_s.empty?
-      person.account.policy_group_ids = defid  if no_policy_group_ids?(person)
+      remove_account_when_no_email!(person) if person.email.to_s.empty?
+      next unless account = person.account
+      next if options.dig(:exclude, :account)
+      if account.policy_group_ids.empty? && def_pg
+        account.policy_group_ids = [def_pg]
+      end
+      add_login_method_if_applicable!(account)
     end
 
     warn_account_removal!
@@ -39,20 +48,34 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
     return !!person.original_doc["account"]
   end
 
-  def no_policy_group_ids?(person)
-    (account = person.account) &&  account.policy_group_ids.empty?
+  def add_login_method_if_applicable!(account)
+    return unless account.as_update.key?("login_provider_ids")
+    if account.login_provider_ids.empty? && def_login
+      account.login_provider_ids = [def_login]
+    end
+  end
+
+  def def_pg
+    @def_pg ||= policy_groups.to_id(default_group)
   end
 
-  def defid
-    @defid ||= policy_groups.to_id([default_group]).compact
+  def def_login
+    @def_login ||= login_providers.to_id(default_login)
   end
 
   def default_group
-    session.config.people.default_usergroup
+    config.people.default_usergroup
+  end
+
+  def default_login
+    config.people.default_login_method
+  end
+
+  def login_providers
+    session.login_providers
   end
 
   def policy_groups
     session.policy_groups
   end
-
 end

data/lib/eco/api/session/config/people.rb

@@ -86,7 +86,19 @@ module Eco
           def default_schema?
             !!self["default_schema"]
           end
-          
+
+          def default_login_method=(name)
+            self["default_login_method"] = name
+          end
+
+          def default_login_method
+            self["default_login_method"]
+          end
+
+          def default_login_method?
+            !!self["default_login_method"]
+          end
+
           # @return [Hash] with defined pairs format `key` and Person parsers.
           def parsers
             self["parsers"] ||= {}

data/lib/eco/api/session/config.rb

@@ -297,6 +297,11 @@ module Eco
           people.default_schema = name
         end
 
+        # Set the **default login method** that users should acquire.
+        def default_login_method=(name)
+          people.default_login_method = name
+        end
+
         # @see Eco::API::Session::Config::People
         # @param (see Eco::API::Session::Config::People)
         # @return [Eco::API::Common::People::PersonParser] parser/serializer for the defined `format`.

data/lib/eco/api/usecases/default_cases/clear_abilities_case.rb

@@ -0,0 +1,22 @@
+class Eco::API::UseCases::DefaultCases::ClearAbilitiesTransCase < Eco::API::Common::Loaders::UseCase
+  name "clear-abilities"
+  type :transform
+
+  def main(people, session, options, usecase)
+    clear_abilities(people.users, session, options, usecase)
+  end
+
+  private
+
+  def clear_abilities(users, session, options, usecase)
+    update   = session.new_job("main", "clear-abilities", :update, usecase, :account)
+    users.each do |person|
+      person.account.permissions_custom = nil_abilities.dup
+      update.add(person)
+    end
+  end
+
+  def nil_abilities
+    @nil_abilities ||= Eco::API::Organization::PresetsFactory.all_abilities
+  end
+end

data/lib/eco/api/usecases/default_cases.rb

@@ -15,6 +15,7 @@ require_relative 'default_cases/analyse_people_case'
 require_relative 'default_cases/append_usergroups_case'
 require_relative 'default_cases/change_email_case'
 require_relative 'default_cases/clean_unknown_tags_case'
+require_relative 'default_cases/clear_abilities_case'
 require_relative 'default_cases/codes_to_tags_case'
 require_relative 'default_cases/create_case'
 require_relative 'default_cases/create_details_case'

data/lib/eco/cli/config/default/usecases.rb

@@ -196,6 +196,10 @@ ASSETS.cli.config do |cnf|
       options.deep_merge!(force: {invite: true})
     end
 
+    desc  = "Clears the `permissions_custom`, provided that Policy Group abilities alone apply."
+    desc += " Please be mindfull if you use this option (there may be users that have been upgraded in ad-hoc manner)."
+    cases.add("-clear-abilities", :transform, desc, case_name: "clear-abilities")
+
     desc = "Deletes everybody that has been filtered from the people manager"
     cases.add("-delete", :transform, desc, case_name: "delete")
     desc = "Deletes the people specified in the input data"

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.57"
+  VERSION = "2.0.60"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.57
+  version: 2.0.60
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.27
+        version: 0.8.28
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.27
+        version: 0.8.28
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -437,6 +437,7 @@ files:
 - lib/eco/api/common/session/sftp.rb
 - lib/eco/api/common/version_patches.rb
 - lib/eco/api/common/version_patches/ecoportal_api.rb
+- lib/eco/api/common/version_patches/ecoportal_api/external_details.rb
 - lib/eco/api/common/version_patches/ecoportal_api/external_person.rb
 - lib/eco/api/common/version_patches/ecoportal_api/internal_person.rb
 - lib/eco/api/common/version_patches/exception.rb
@@ -528,6 +529,7 @@ files:
 - lib/eco/api/usecases/default_cases/append_usergroups_case.rb
 - lib/eco/api/usecases/default_cases/change_email_case.rb
 - lib/eco/api/usecases/default_cases/clean_unknown_tags_case.rb
+- lib/eco/api/usecases/default_cases/clear_abilities_case.rb
 - lib/eco/api/usecases/default_cases/codes_to_tags_case.rb
 - lib/eco/api/usecases/default_cases/create_case.rb
 - lib/eco/api/usecases/default_cases/create_details_case.rb