eco-helpers 2.7.10 → 2.7.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e9c00a0ecc4c1fb42d808e2df03a8618c7017be7a27e6319859bd7974b3638a
-  data.tar.gz: f9e2452935fcfc3712e53b5e5731151f1ddf6a4f946f2e1c6f8c629f48e09e9e
+  metadata.gz: 5d3edc9e39edaf452a269851133444e67a2c743cfa8f787723106022eb3694b1
+  data.tar.gz: 28f0547c71389caa7fbf2a416d52a3cc64fa191610040e3484243612cd53e523
 SHA512:
-  metadata.gz: 4e4595657f37f057269bbd38671858700bdcc22e2755e3b365bbe69e48e017e11974a8583b5e93c09c1abf90cd4f09c0ed8ac4a853be8d471c51719fa1500e71
-  data.tar.gz: 0e3af7794e45e62fdbb2ba06340cc7b23ea88466670eb8b597c4e279556bb5cc59dfa5f8ff0f294f77d15dfd159819590cd2228d05fa19af8a2421d4b665fa72
+  metadata.gz: fc3bee60f32f2c1d16c6a4f6901d9a50f8bdb8b01134f0040fbedbee8c36b7315e424f0e16c1da9ddf6a8b635b21ec0fcff6954143ee102a44ca51048d36a2ff
+  data.tar.gz: fa238d1c36f0deb74d94de407c06c29e75567073a289e8939ec6280362a367785a614fa99f37de1d13b63e35d5eee7fa51e3a02c84ed2aa8dec5fdfdbbf1bc7e

data/CHANGELOG.md

@@ -1,21 +1,31 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.7.12] - 2024-05-xx
+
+## [2.7.13] - 2024-05-xx
 
 ### Added
 ### Changed
 ### Fixed
 
-## [2.7.11] - 2024-05-20
+## [2.7.12] - 2024-05-30
 
 ### Changed
-  - Upgrade SFTP access
+  - Decouple `Eco::API::UseCases::Default::People` namespace
+
+## [2.7.11] - 2024-05-27
 
-## [2.7.10] - 2024-05-16
+### Changed\
+  - `Eco::API::Common::Session::SFTP#download`
+    - It now returns the local filename(s) of the downloaded files.
+  - `Eco::API::UseCases::GraphQL::Utils#sftp_download_files`
+    - It now returns the local filename(s) of the downloaded files.
+
+## [2.7.10] - 2024-05-20
 
 ### Changed
   - Temporarily silent warnings on tracking id changes (apparently the tracking locations tree is not up to date with latest version and gives false warnings)
+  - Upgrade SFTP access
 
 ### Fixed
   - Remove enviro from tagtree download

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

@@ -74,15 +74,19 @@ module Eco
           # @see Net::SFTP::Operations::Download
           # @param files [String, Array<String>] full path to remote file(s) to be downloaded
           # @param local_folder [String] local destination folder (`"."` if not specified)
-          def download(files, local_folder: nil)
+          # @return [Array<String>] list of created files
+          def download(files, local_folder: nil, &block)
             puts "Creating local files:"
+            created_files = []
             [files].flatten.compact.map do |fullname|
               basename = windows_basename(fullname)
               dest_fullname = File.join(local_folder || ".", basename)
               puts " • #{dest_fullname}"
+              created_files << dest_fullname
               sftp_session.download(fullname, dest_fullname)
             end.each(&:wait)
             # run SSH event loop while dw.active?
+            created_files.tap { created_files.each(&block) }
           end
 
           # Upload a file to the specific `remote_folder`

data/lib/eco/api/usecases/default/people/{clean_unknown_tags_case.rb → amend/clean_unknown_tags_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::CleanUnknownTags < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Amend::CleanUnknownTags < Eco::API::Common::Loaders::UseCase
   name "clean-unknown-tags"
   type :transform
 
@@ -35,7 +35,7 @@ class Eco::API::UseCases::Default::People::CleanUnknownTags < Eco::API::Common::
   private
 
   def default_tag(person)
-    return nil unless account = person.account
+    return unless (account = person.account)
     account.default_tag
   end
 

data/lib/eco/api/usecases/default/people/{clear_abilities_case.rb → amend/clear_abilities_case.rb}

@@ -1,8 +1,8 @@
-class Eco::API::UseCases::Default::People::ClearAbilitiesTransCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Amend::ClearAbilitiesTransCase < Eco::API::Common::Loaders::UseCase
   name "clear-abilities"
   type :transform
 
-  def main(people, _session, _options, _usecase)
+  def main(*_args)
     clear_abilities(people.users)
   end
 

data/lib/eco/api/usecases/default/people/{refresh_case.rb → amend/refresh_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::RefreshCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Amend::RefreshCase < Eco::API::Common::Loaders::UseCase
   name "refresh"
   type :transform
 

data/lib/eco/api/usecases/default/people/amend/reinvite_sync_case.rb

@@ -0,0 +1,11 @@
+module Eco::API::UseCases::Default::People::Amend
+  class ReinviteSyncCase < ReinviteTransCase
+    name "reinvite"
+    type :sync
+
+    def main(entries, *_args)
+      found = micro.with_each_present(entries, people, options, log_starter: true)
+      reinvite(found.users)
+    end
+  end
+end

data/lib/eco/api/usecases/default/people/{reinvite_trans_case.rb → amend/reinvite_trans_case.rb}

@@ -1,8 +1,8 @@
-class Eco::API::UseCases::Default::People::ReinviteTransCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Amend::ReinviteTransCase < Eco::API::Common::Loaders::UseCase
   name "reinvite"
   type :transform
 
-  def main(people, session, options, usecase)
+  def main(*_args)
     reinvite(people.users)
   end
 

data/lib/eco/api/usecases/default/people/amend/reinvite_trans_cli.rb

@@ -0,0 +1,4 @@
+class Eco::API::UseCases::Default::People::Amend::ReinviteTransCase
+  class Cli < Eco::API::UseCases::Cli
+  end
+end

data/lib/eco/api/usecases/default/people/{restore_db_case.rb → amend/restore_db_case.rb}

@@ -1,6 +1,6 @@
 # @example
 #     -restore-db-from backup.json -skip-api-policies -skip-batch-policy -include-excluded -simulate
-class Eco::API::UseCases::Default::People::RestoreDBCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Amend::RestoreDBCase < Eco::API::Common::Loaders::UseCase
   name "restore-db"
   type :sync
 

data/lib/eco/api/usecases/default/people/amend.rb

@@ -0,0 +1,11 @@
+module Eco::API::UseCases::Default::People
+  module Amend
+  end
+end
+
+require_relative 'amend/clean_unknown_tags_case'
+require_relative 'amend/clear_abilities_case'
+require_relative 'amend/reinvite_trans_case'
+require_relative 'amend/reinvite_sync_case'
+require_relative 'amend/refresh_case'
+require_relative 'amend/restore_db_case'

data/lib/eco/api/usecases/default/people/{analyse_people_case.rb → treat/analyse_people_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::Analyse < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Treat::Analyse < Eco::API::Common::Loaders::UseCase
   name "analyse-people"
   type :export
 

data/lib/eco/api/usecases/default/people/{org_data_convert_case.rb → treat/org_data_convert_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::OrgDataConvertCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Treat::OrgDataConvertCase < Eco::API::Common::Loaders::UseCase
   name "org-data-convert"
   type :import
 

data/lib/eco/api/usecases/default/people/{supers_cyclic_identify_case.rb → treat/supers_cyclic_identify_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::SupersCyclicIdentify < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Treat::SupersCyclicIdentify < Eco::API::Common::Loaders::UseCase
   name "identify-cyclic-supers"
   type :export
 
@@ -62,7 +62,7 @@ class Eco::API::UseCases::Default::People::SupersCyclicIdentify < Eco::API::Comm
 
     "".tap do |str|
       entry = set.shift
-      str << "  " * lev
+      str << ("  " * lev)
       str << lev&.positive? ? "+-#{lev}- " : ""
       str << entry.name
       str << " (#{entry.external_id}|#{entry.email}|#{entry.id})\n"

data/lib/eco/api/usecases/default/people/{supers_hierarchy_case.rb → treat/supers_hierarchy_case.rb}

@@ -1,10 +1,10 @@
-class Eco::API::UseCases::Default::People::SupersHierarchy < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Treat::SupersHierarchy < Eco::API::Common::Loaders::UseCase
   name "supers-hierarchy"
   type :export
 
   attr_reader :people
 
-  def main(people, session, options, usecase)
+  def main(people, _session, options, _usecase)
     options[:end_get] = false
     @people = people
 
@@ -22,20 +22,19 @@ class Eco::API::UseCases::Default::People::SupersHierarchy < Eco::API::Common::L
   end
 
   def save!(data)
-    ext  = File.extname(file).downcase.delete(".")
-
-    File.open(file, "w") do |fd|
-      if ext == "txt"
-        create_file(data, file: file, format: :txt)
-      elsif ext == "html"
-        puts "html is still not supported"
-        exit(1)
-        create_file(data, file: file, format: :html)
-      elsif ext == "json"
-        puts "json is still not supported"
-        exit(1)
-        create_file(data, file: file, format: :json)
-      end
+    ext = File.extname(file).downcase.delete(".")
+
+    case ext
+    when "txt"
+      create_file(data, file: file, format: :txt)
+    when "html"
+      puts "html is still not supported"
+      exit(1)
+      # create_file(data, file: file, format: :html)
+    when "json"
+      puts "json is still not supported"
+      exit(1)
+      # create_file(data, file: file, format: :json)
     end
   end
 
@@ -50,7 +49,9 @@ class Eco::API::UseCases::Default::People::SupersHierarchy < Eco::API::Common::L
     raise "Required Hash tree structure. Given: #{tree.class}" unless tree.is_a?(Hash)
     "".tap do |str|
       tree.each do |entry, subtree|
-        str << "#{"  " * lev}#{(lev > 0)? "+-#{lev}- " : ""}#{entry.name} (#{entry.external_id}|#{entry.email}|#{entry.id})\n"
+        str << "#{"  " * lev}#{lev.positive? ? "+-#{lev}- " : ""}"
+        str << entry.name
+        str << " (#{entry.external_id}|#{entry.email}|#{entry.id})\n"
         str << tree_to_str(subtree, lev: lev + 1, format: format) unless !subtree || subtree.empty?
       end
     end

data/lib/eco/api/usecases/default/people/treat.rb

@@ -0,0 +1,9 @@
+module Eco::API::UseCases::Default::People
+  module Treat
+  end
+end
+
+require_relative 'treat/analyse_people_case'
+require_relative 'treat/supers_hierarchy_case'
+require_relative 'treat/supers_cyclic_identify_case'
+require_relative 'treat/org_data_convert_case'

data/lib/eco/api/usecases/default/people/{change_email_case.rb → utils/change_email_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::ChangeEMailCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Utils::ChangeEMailCase < Eco::API::Common::Loaders::UseCase
   name "change-email"
   type :sync
 

data/lib/eco/api/usecases/default/people/{set_default_tag_case.rb → utils/set_default_tag_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::SetDefaultTagCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Utils::SetDefaultTagCase < Eco::API::Common::Loaders::UseCase
   name "set-default-tag"
   type :transform
 

data/lib/eco/api/usecases/default/people/{switch_supervisor_case.rb → utils/switch_supervisor_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::SwitchSupervisorCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Utils::SwitchSupervisorCase < Eco::API::Common::Loaders::UseCase
   name "switch-supervisor"
   type :transform
 

data/lib/eco/api/usecases/default/people/{transfer_account_case.rb → utils/transfer_account_case.rb}

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::TransferAccountCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::People::Utils::TransferAccountCase < Eco::API::Common::Loaders::UseCase
   name "transfer-account"
   type :sync
 

data/lib/eco/api/usecases/default/people/utils.rb

@@ -0,0 +1,9 @@
+module Eco::API::UseCases::Default::People
+  module Utils
+  end
+end
+
+require_relative 'utils/change_email_case'
+require_relative 'utils/set_default_tag_case'
+require_relative 'utils/switch_supervisor_case'
+require_relative 'utils/transfer_account_case'

data/lib/eco/api/usecases/default/people.rb

@@ -9,17 +9,7 @@ module Eco
   end
 end
 
-require_relative 'people/analyse_people_case'
-require_relative 'people/change_email_case'
-require_relative 'people/clean_unknown_tags_case'
-require_relative 'people/clear_abilities_case'
-require_relative 'people/reinvite_trans_case'
-require_relative 'people/reinvite_sync_case'
-require_relative 'people/org_data_convert_case'
-require_relative 'people/refresh_case'
-require_relative 'people/restore_db_case'
-require_relative 'people/set_default_tag_case'
-require_relative 'people/supers_hierarchy_case'
-require_relative 'people/supers_cyclic_identify_case'
-require_relative 'people/switch_supervisor_case'
-require_relative 'people/transfer_account_case'
+require_relative 'people/treat'
+require_relative 'people/utils'
+require_relative 'people/amend'
+

data/lib/eco/api/usecases/graphql/utils/sftp.rb

@@ -19,20 +19,20 @@ module Eco::API::UseCases::GraphQL::Utils
       end
     end
 
-    def sftp_download_files(subfolder: remote_subfolder, pattern: nil, local_folder: self.local_folder)
-      with_remote_files(subfolder: subfolder, pattern: pattern).tap do |files|
-        next if files.empty?
-        file_names = files.map {|file| to_remote_path(file.name, subfolder: subfolder)}
-
-        log(:info) {
-          msg  = "Getting the following files into the local folder '#{local_folder}':\n"
-          msg << "  • "
-          msg << file_names.join("\n  • ")
-          msg
-        }
-
-        sftp.download(file_names, local_folder: local_folder)
-      end
+    def sftp_download_files(subfolder: remote_subfolder, pattern: nil, local_folder: self.local_folder, &block)
+      remote_files = with_remote_files(subfolder: subfolder, pattern: pattern)
+      return [] if remote_files.empty?
+
+      file_names = remote_files.map {|file| to_remote_path(file.name, subfolder: subfolder)}
+
+      log(:info) {
+        msg  = "Getting the following files into the local folder '#{local_folder}':\n"
+        msg << "  • "
+        msg << file_names.join("\n  • ")
+        msg
+      }
+
+      sftp.download(file_names, local_folder: local_folder, &block)
     end
 
     def sftp_move_file(source, dest)

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '2.7.10'.freeze
+  VERSION = '2.7.12'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.7.10
+  version: 2.7.12
 platform: ruby
 authors:
 - Oscar Segura
@@ -673,21 +673,24 @@ files:
 - lib/eco/api/usecases/default/locations/tagtree_extract_case.rb
 - lib/eco/api/usecases/default/locations/tagtree_upload_case.rb
 - lib/eco/api/usecases/default/people.rb
-- lib/eco/api/usecases/default/people/analyse_people_case.rb
-- lib/eco/api/usecases/default/people/change_email_case.rb
-- lib/eco/api/usecases/default/people/clean_unknown_tags_case.rb
-- lib/eco/api/usecases/default/people/clear_abilities_case.rb
-- lib/eco/api/usecases/default/people/org_data_convert_case.rb
-- lib/eco/api/usecases/default/people/refresh_case.rb
-- lib/eco/api/usecases/default/people/reinvite_sync_case.rb
-- lib/eco/api/usecases/default/people/reinvite_trans_case.rb
-- lib/eco/api/usecases/default/people/reinvite_trans_cli.rb
-- lib/eco/api/usecases/default/people/restore_db_case.rb
-- lib/eco/api/usecases/default/people/set_default_tag_case.rb
-- lib/eco/api/usecases/default/people/supers_cyclic_identify_case.rb
-- lib/eco/api/usecases/default/people/supers_hierarchy_case.rb
-- lib/eco/api/usecases/default/people/switch_supervisor_case.rb
-- lib/eco/api/usecases/default/people/transfer_account_case.rb
+- lib/eco/api/usecases/default/people/amend.rb
+- lib/eco/api/usecases/default/people/amend/clean_unknown_tags_case.rb
+- lib/eco/api/usecases/default/people/amend/clear_abilities_case.rb
+- lib/eco/api/usecases/default/people/amend/refresh_case.rb
+- lib/eco/api/usecases/default/people/amend/reinvite_sync_case.rb
+- lib/eco/api/usecases/default/people/amend/reinvite_trans_case.rb
+- lib/eco/api/usecases/default/people/amend/reinvite_trans_cli.rb
+- lib/eco/api/usecases/default/people/amend/restore_db_case.rb
+- lib/eco/api/usecases/default/people/treat.rb
+- lib/eco/api/usecases/default/people/treat/analyse_people_case.rb
+- lib/eco/api/usecases/default/people/treat/org_data_convert_case.rb
+- lib/eco/api/usecases/default/people/treat/supers_cyclic_identify_case.rb
+- lib/eco/api/usecases/default/people/treat/supers_hierarchy_case.rb
+- lib/eco/api/usecases/default/people/utils.rb
+- lib/eco/api/usecases/default/people/utils/change_email_case.rb
+- lib/eco/api/usecases/default/people/utils/set_default_tag_case.rb
+- lib/eco/api/usecases/default/people/utils/switch_supervisor_case.rb
+- lib/eco/api/usecases/default/people/utils/transfer_account_case.rb
 - lib/eco/api/usecases/default_cases.rb
 - lib/eco/api/usecases/default_cases/create_case.rb
 - lib/eco/api/usecases/default_cases/delete_sync_case.rb

data/lib/eco/api/usecases/default/people/reinvite_sync_case.rb

@@ -1,9 +0,0 @@
-class Eco::API::UseCases::Default::People::ReinviteSyncCase < Eco::API::UseCases::Default::People::ReinviteTransCase
-  name "reinvite"
-  type :sync
-
-  def main(entries, people, session, options, usecase)
-    found = micro.with_each_present(entries, people, options, log_starter: true)
-    reinvite(found.users)
-  end
-end

data/lib/eco/api/usecases/default/people/reinvite_trans_cli.rb

@@ -1,4 +0,0 @@
-class Eco::API::UseCases::Default::People::ReinviteTransCase
-  class Cli < Eco::API::UseCases::Cli
-  end
-end