eco-helpers 2.0.50 → 2.0.53

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c8f3ba10e4524d33de8f1339a48fa9c48c86a7e1b0650e29710d05083b6ed82
-  data.tar.gz: f68a0adda4ccebff9552e652bc47bc25cbc72129fe025e5c31b9c542b83ed9f3
+  metadata.gz: 71ac6b334999283d1bab07efdb1ece3fdbbfaa56052f292010a3741faad92351
+  data.tar.gz: e432429671478dcca99ef444f1db0eeab66d9ad2dc7150cfc12577fb06f5b1e7
 SHA512:
-  metadata.gz: 215c64f98db5f29daad59fad9b4f559e0c7e2a136671d87ab9e37a6e2403cafb123948fbb8cd852ddb3155f35e4b52545d9d948df638402f7c3a63797a397690
-  data.tar.gz: 8a6119977b69ef6aa699ed718142d377866c1c5f379027b9b5713655525f578f837cf543df70be3dbeee1868cd6328f12ee782b1ba743f1aa87ce4cc592bc2cb
+  metadata.gz: ff99f0de94a2e87730f2d6b8496d4d556cbfe7ec3bb99289f3e27cf30512e0644b33f142f0664ee2c5f9f91e7fc13b83bc62178af26f3e0929668acd94f95088
+  data.tar.gz: 3b9b43011552a1cb9f37a46c18cabab8ad2892b3634908895ddd99b2269151c65bd3a4c5a6281ab080396ea3ec0890f29fd5f1e37c8427d80bbdb2c2e240b91f

data/CHANGELOG.md

@@ -1,7 +1,32 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.50] - 2022-02-xx
+## [2.0.53] - 2022-03-xx
+
+### Added
+  - `Eco::API::MicroCases#set_supervisor` prevent to set someone as supervisor of themselves.
+  - `Eco::API::UseCases::DefaultCases::Samples::Sftp` integration to modify the `source_folder`
+  
+### Changed
+  - upgrade `ecoportal-api` and `ecoportal-api-v2` dependencies
+
+### Fixed
+
+## [2.0.52] - 2022-03-04
+
+### Added
+  - `Eco::API::UseCases::DefaultCases::CleanUnknownTags` include `default_tag` refresh
+
+### Fixed
+  - `Eco::Data::Files::Directory#dir_files` to be returned in alphabetic order
+
+## [2.0.51] - 2022-02-27
+
+### Added
+  - `Eco::API::MicroCases#person_update!` launches an update against the Server for one person
+  - `Eco::API::MicroCases#take_email_from_account` with given an account associated to an `email` that we cannot take, it associates that account to a different email
+
+## [2.0.50] - 2022-02-23
 
 ### Added
   - Ability to configure delay between jobs and job groups
@@ -15,8 +40,6 @@ All notable changes to this project will be documented in this file.
 ### Changed
   - `workflow`, when no operation specified it logs as `info`, rather than `warn`
 
-### Fixed
-
 ## [2.0.49] - 2022-02-14
 
 ### Added

data/eco-helpers.gemspec

@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
   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.4', '< 0.9'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.25', '< 0.9'
+  spec.add_dependency 'ecoportal-api', '>= 0.8.5', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.26', '< 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/microcases/person_update.rb

@@ -0,0 +1,39 @@
+module Eco
+  module API
+    class MicroCases
+      # It updates an idividual person.
+      # @note if it succeeds the update, it calls `person.consolidate!`
+      # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
+      # @param context [String] main part of the message.
+      # @param reason [String] why are we updating now.
+      # @return [Boolean] `true` if it succeded to update, and `false` otherwise
+      def person_update!(person, context: "Session", reason: "")
+        logger.debug("#{context}, going to \"#{reason}\".\nPerson: #{person_ref(person)}")
+        if response = api.people.update(person)
+          if response.success?
+            person.consolidate!
+            true
+          else
+            msg  = "#{context} Error #{response.status}: #{response.body}\n"
+            msg += " -- Failed to \"#{reason}\".\n"
+            msg += "  • Person: #{person_ref(person)}"
+            logger.error(msg)
+            false
+          end
+        else
+          msg  = "#{context} Error (connection error)\n"
+          msg += " -- Failed to \"#{reason}\".\n"
+          msg += "  • Person: #{person_ref(person)}"
+          logger.error(msg)
+          false
+        end
+      end
+
+      private
+
+      def person_ref(person)
+        Eco::API::Session::Batch::Feedback.person_ref(person)
+      end
+    end
+  end
+end

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

@@ -2,6 +2,8 @@ module Eco
   module API
     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)
       # @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.
@@ -10,6 +12,7 @@ module Eco
       # @yieldparam supervisor_id [String] the **unknown** `supervisor_id`.
       def set_supervisor(person, sup_id, people, options)
         unless options.dig(:exclude, :core) || options.dig(:exclude, :supervisor)
+          return false if sup_id && ((person.id == sup_id) || (person.external_id == sup_id))
           cur_id    = person.supervisor_id
           cur_super = cur_id && with_supervisor(cur_id, people)
           micro.with_supervisor(sup_id, people) do |new_super|

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

@@ -0,0 +1,89 @@
+module Eco
+  module API
+    class MicroCases
+      # Frees up `target_email` from an account not present in this org.
+      #   Allows to force `target_email` on the current user's account.
+      #   - If the person does not have account, this case will not do anything.
+      #   - If `original_doc["account"]` is `nil` (no account on server side), this case will not do anything.
+      #   - If the `target_email` and the `current_email` are the same or empty, this case will not do anything.
+      # @note
+      #   - **It does not do the final update to the server to the `target_email`**. You will need to do this part yourself.
+      #   - You would call this function only when you got an error of `email already taken`.
+      #   - If the `target_email` is associated to a user in the same org, this will fail.
+      # @param person [Ecoportal::API::V1::Person] the person we want to update, carrying the changes to be done.
+      # @param dest_email [String, Proc] the email that we will move the other account to, when we free up `target_email`.
+      # @param target_email [String] the email that we want to free up from another account and bring to ours.
+      #   If it's empty, the `person.email` will be used instead.
+      # @param options [Hash] the options.
+      # @param current_email [String] the email that the person's account is currently linked.
+      #   As the current email should be associated with this person's account on server side, we use `original_doc["email"]`.
+      # @param context [String] main core part of logs. Provides context to the logs.
+      def take_email_from_account(person, dest_email:, target_email: nil, options: {}, context: "Session")
+        return false if options.dig(:exclude, :account)
+        return false unless account     = person.account
+        return false unless had_account = person.original_doc["account"]
+
+        target_email  ||= person.email
+        account_email   = person.original_doc["email"]
+
+        return false unless target_email != account_email
+        return false if account_email.to_s.strip.empty?
+        return false if target_email.to_s.strip.empty?
+
+        if dest_email.is_a?(String)
+          return false unless target_email != dest_email
+          return false unless dest_email   != account_email
+          return false if dest_email.to_s.strip.empty?
+        end
+
+        account_json  = JSON.parse(account.to_json)
+        person.email = account_email
+
+        if success = _take_email_remove_account!(person, context: context)
+          if success = _take_email_acquire_account!(person, target_email, account: {}, context: context)
+            if success = _take_email_email_free_up!(person, dest_email: dest_email, context: context)
+              if success = _take_email_remove_account!(person, context: context)
+                if success = _take_email_acquire_account!(person, account_email, account: account_json, context: context)
+                  person.email = target_email
+                end
+              end
+            else # free up target email
+              # restore
+              if _take_email_remove_account!(person, context: context)
+                _take_email_acquire_account!(person, account_email, account: account_json, context: context)
+              end
+              success = false
+            end
+          else # aquire other account
+            # restore
+            _take_email_acquire_account!(person, account_email, account: account_json, context: context)
+            success = false
+          end
+        end
+        success
+      end
+
+      private
+
+      def _take_email_acquire_account!(person, target_email, account: {}, context: "Session")
+        person.account = account
+        person.account.send_invites = false
+        person.email   = target_email
+        micro.person_update!(person, reason: "bring account with email '#{target_email}'", context: context)
+      end
+
+      def _take_email_email_free_up!(person, dest_email:, target_email: nil, context: "Session")
+        target_email ||= person.email
+        person.email   = dest_email.is_a?(Proc)? dest_email.call(target_email) : dest_email
+        reason = "free up email '#{target_email}', by moving account to '#{person.email}'"
+        micro.person_update!(person, reason: reason, context: context)
+      end
+
+      def _take_email_remove_account!(person, context: "Session")
+        person.account = nil
+        micro.person_update!(person, reason: "remove account", context: context)
+      end
+
+    end
+  end
+end

data/lib/eco/api/microcases.rb

@@ -19,6 +19,7 @@ require_relative 'microcases/people_cache'
 require_relative 'microcases/people_load'
 require_relative 'microcases/people_refresh'
 require_relative 'microcases/people_search'
+require_relative 'microcases/person_update'
 require_relative 'microcases/preserve_filter_tags'
 require_relative 'microcases/preserve_default_tag'
 require_relative 'microcases/preserve_policy_groups'
@@ -26,9 +27,10 @@ require_relative 'microcases/set_account'
 require_relative 'microcases/set_core_with_supervisor'
 require_relative 'microcases/set_core'
 require_relative 'microcases/refresh_default_tag'
+require_relative 'microcases/s3upload_targets'
 require_relative 'microcases/set_supervisor'
 require_relative 'microcases/strict_search'
-require_relative 'microcases/s3upload_targets'
+require_relative 'microcases/take_email_from_account'
 require_relative 'microcases/with_each'
 require_relative 'microcases/with_each_leaver'
 require_relative 'microcases/with_each_present'

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

@@ -23,6 +23,12 @@ class Eco::API::UseCases::DefaultCases::CleanUnknownTags < Eco::API::Common::Loa
       unknown_tags = person.filter_tags.select {|tag| !tag?(tag)}
       person.filter_tags -= unknown_tags
       unknown_tag!(*unknown_tags)
+      if (account = person.account) && tag = account.default_tag
+        unless tag?(tag)
+          micro.refresh_default_tag(person.entry, person, options)
+          unknown_tag!(tag)
+        end
+      end
       update.add(person)
     end
   end

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

@@ -2,10 +2,10 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
   name "sftp-sample"
   type :other
 
-  attr_reader :session
+  attr_reader :session, :options
 
   def main(session, options, usecase)
-    @session = session
+    @session = session; @options = options
     options[:end_get] = false
     raise "The SFTP is not configured" unless session.sftp?
     case options.dig(:sftp, :command)
@@ -92,7 +92,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
   end
 
   def local_folder
-    "."
+    options.dig(:sftp, :local_folder) || "."
   end
 
   def remote_folder

data/lib/eco/data/files/directory.rb

@@ -53,7 +53,7 @@ module Eco
 
         def dir_files(file: nil, pattern: dir_pattern)
           find = !!file ? file_pattern(file) : file_pattern(pattern)
-          Dir.glob(find)
+          Dir.glob(find).sort
         end
 
         def newest_file(files_list = nil, file: nil)

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.50"
+  VERSION = "2.0.53"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.50
+  version: 2.0.53
 platform: ruby
 authors:
 - Oscar Segura
@@ -116,7 +116,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 0.8.5
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -126,7 +126,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 0.8.5
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.25
+        version: 0.8.26
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.25
+        version: 0.8.26
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -462,6 +462,7 @@ files:
 - lib/eco/api/microcases/people_load.rb
 - lib/eco/api/microcases/people_refresh.rb
 - lib/eco/api/microcases/people_search.rb
+- lib/eco/api/microcases/person_update.rb
 - lib/eco/api/microcases/preserve_default_tag.rb
 - lib/eco/api/microcases/preserve_filter_tags.rb
 - lib/eco/api/microcases/preserve_policy_groups.rb
@@ -472,6 +473,7 @@ files:
 - lib/eco/api/microcases/set_core_with_supervisor.rb
 - lib/eco/api/microcases/set_supervisor.rb
 - lib/eco/api/microcases/strict_search.rb
+- lib/eco/api/microcases/take_email_from_account.rb
 - lib/eco/api/microcases/with_each.rb
 - lib/eco/api/microcases/with_each_leaver.rb
 - lib/eco/api/microcases/with_each_present.rb