eco-helpers 1.5.1 → 1.5.2

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "1.5.1"
+  VERSION = "1.5.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Oscar Segura
@@ -116,7 +116,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.7.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
@@ -126,7 +126,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.7.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
@@ -242,14 +242,23 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - eco-helpers.gemspec
 - lib/eco-helpers.rb
 - lib/eco/api.rb
 - lib/eco/api/common.rb
+- lib/eco/api/common/base_loader.rb
+- lib/eco/api/common/class_auto_loader.rb
 - lib/eco/api/common/class_helpers.rb
 - lib/eco/api/common/class_hierarchy.rb
+- lib/eco/api/common/class_meta_basics.rb
+- lib/eco/api/common/loaders.rb
+- lib/eco/api/common/loaders/error_handler.rb
+- lib/eco/api/common/loaders/parser.rb
+- lib/eco/api/common/loaders/policy.rb
+- lib/eco/api/common/loaders/use_case.rb
 - lib/eco/api/common/people.rb
 - lib/eco/api/common/people/base_parser.rb
 - lib/eco/api/common/people/default_parsers.rb
@@ -257,6 +266,7 @@ files:
 - lib/eco/api/common/people/default_parsers/csv_parser.rb
 - lib/eco/api/common/people/default_parsers/date_parser.rb
 - lib/eco/api/common/people/default_parsers/freemium_parser.rb
+- lib/eco/api/common/people/default_parsers/login_providers_parser.rb
 - lib/eco/api/common/people/default_parsers/multi_parser.rb
 - lib/eco/api/common/people/default_parsers/numeric_parser.rb
 - lib/eco/api/common/people/default_parsers/policy_groups_parser.rb
@@ -286,18 +296,39 @@ files:
 - lib/eco/api/common/version_patches/exception.rb
 - lib/eco/api/common/version_patches/hash.rb
 - lib/eco/api/common/version_patches/hash/deep_merge.rb
+- lib/eco/api/custom.rb
+- lib/eco/api/custom/error_handler.rb
+- lib/eco/api/custom/namespace.rb
+- lib/eco/api/custom/parser.rb
+- lib/eco/api/custom/policy.rb
+- lib/eco/api/custom/use_case.rb
 - lib/eco/api/error.rb
 - lib/eco/api/error/handler.rb
 - lib/eco/api/error/handlers.rb
 - lib/eco/api/microcases.rb
+- lib/eco/api/microcases/account_excluded.rb
+- lib/eco/api/microcases/append_usergroups.rb
 - lib/eco/api/microcases/core_excluded.rb
+- lib/eco/api/microcases/fix_default_group.rb
 - lib/eco/api/microcases/fix_filter_tags.rb
+- lib/eco/api/microcases/people_cache.rb
+- 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/refresh_abilities.rb
+- lib/eco/api/microcases/refresh_default_tag.rb
+- lib/eco/api/microcases/s3upload_targets.rb
 - lib/eco/api/microcases/set_account.rb
 - lib/eco/api/microcases/set_core.rb
-- lib/eco/api/microcases/set_default_group.rb
-- lib/eco/api/microcases/set_default_tag.rb
+- 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/with_each.rb
+- lib/eco/api/microcases/with_each_leaver.rb
+- lib/eco/api/microcases/with_each_present.rb
+- lib/eco/api/microcases/with_each_starter.rb
+- lib/eco/api/microcases/with_each_subordinate.rb
+- lib/eco/api/microcases/with_supervisor.rb
 - lib/eco/api/organization.rb
 - lib/eco/api/organization/login_providers.rb
 - lib/eco/api/organization/people.rb
@@ -334,11 +365,20 @@ files:
 - lib/eco/api/session/config/s3_storage.rb
 - lib/eco/api/session/config/sftp.rb
 - lib/eco/api/session/config/workflow.rb
-- lib/eco/api/session/task.rb
 - lib/eco/api/usecases.rb
+- lib/eco/api/usecases/backup/append_usergroups_case.rb
+- lib/eco/api/usecases/backup/create_case.rb
+- lib/eco/api/usecases/backup/create_details_case.rb
+- lib/eco/api/usecases/backup/create_details_with_supervisor_case.rb
+- lib/eco/api/usecases/backup/hris_case.rb
+- lib/eco/api/usecases/backup/set_default_tag_case.rb
+- lib/eco/api/usecases/backup/set_supervisor_case.rb
+- lib/eco/api/usecases/backup/transfer_account_case.rb
+- lib/eco/api/usecases/backup/update_case.rb
+- lib/eco/api/usecases/backup/update_details_case.rb
+- lib/eco/api/usecases/backup/upsert_case.rb
 - lib/eco/api/usecases/base_case.rb
 - lib/eco/api/usecases/base_io.rb
-- lib/eco/api/usecases/default_case.rb
 - lib/eco/api/usecases/default_cases.rb
 - lib/eco/api/usecases/default_cases/append_usergroups_case.rb
 - lib/eco/api/usecases/default_cases/change_email_case.rb
@@ -346,17 +386,22 @@ files:
 - lib/eco/api/usecases/default_cases/create_case.rb
 - lib/eco/api/usecases/default_cases/create_details_case.rb
 - lib/eco/api/usecases/default_cases/create_details_with_supervisor_case.rb
-- lib/eco/api/usecases/default_cases/delete_case.rb
+- lib/eco/api/usecases/default_cases/delete_sync_case.rb
+- lib/eco/api/usecases/default_cases/delete_trans_case.rb
 - lib/eco/api/usecases/default_cases/email_as_id_case.rb
 - lib/eco/api/usecases/default_cases/hris_case.rb
 - lib/eco/api/usecases/default_cases/new_email_case.rb
 - lib/eco/api/usecases/default_cases/new_id_case.rb
-- lib/eco/api/usecases/default_cases/recover_db_case.rb
+- lib/eco/api/usecases/default_cases/new_id_case0.rb
+- lib/eco/api/usecases/default_cases/org_data_convert_case.rb
+- lib/eco/api/usecases/default_cases/refresh_abilities_case.rb
 - lib/eco/api/usecases/default_cases/refresh_case.rb
-- lib/eco/api/usecases/default_cases/refresh_presets_case.rb
-- lib/eco/api/usecases/default_cases/reinvite_case.rb
-- lib/eco/api/usecases/default_cases/remove_account_case.rb
+- lib/eco/api/usecases/default_cases/reinvite_sync_case.rb
+- lib/eco/api/usecases/default_cases/reinvite_trans_case.rb
+- lib/eco/api/usecases/default_cases/remove_account_sync_case.rb
+- lib/eco/api/usecases/default_cases/remove_account_trans_case.rb
 - lib/eco/api/usecases/default_cases/reset_landing_page_case.rb
+- lib/eco/api/usecases/default_cases/restore_db_case.rb
 - lib/eco/api/usecases/default_cases/set_default_tag_case.rb
 - lib/eco/api/usecases/default_cases/set_supervisor_case.rb
 - lib/eco/api/usecases/default_cases/switch_supervisor_case.rb
@@ -366,10 +411,6 @@ files:
 - lib/eco/api/usecases/default_cases/update_case.rb
 - lib/eco/api/usecases/default_cases/update_details_case.rb
 - lib/eco/api/usecases/default_cases/upsert_case.rb
-- lib/eco/api/usecases/microed_cases/hris_case.rb
-- lib/eco/api/usecases/microed_cases/update_case.rb
-- lib/eco/api/usecases/microed_cases/update_details_case.rb
-- lib/eco/api/usecases/microed_cases/upsert_case.rb
 - lib/eco/api/usecases/use_case.rb
 - lib/eco/api/usecases/use_case_chain.rb
 - lib/eco/api/usecases/use_case_io.rb
@@ -378,15 +419,19 @@ files:
 - lib/eco/cli.rb
 - lib/eco/cli/config.rb
 - lib/eco/cli/config/default.rb
-- lib/eco/cli/config/default/filters.rb
 - lib/eco/cli/config/default/input.rb
+- lib/eco/cli/config/default/input_filters.rb
 - lib/eco/cli/config/default/options.rb
 - lib/eco/cli/config/default/people.rb
+- lib/eco/cli/config/default/people_filters.rb
 - lib/eco/cli/config/default/usecases.rb
 - lib/eco/cli/config/default/workflow.rb
+- lib/eco/cli/config/filters.rb
+- lib/eco/cli/config/filters/input_filters.rb
+- lib/eco/cli/config/filters/people_filters.rb
+- lib/eco/cli/config/help.rb
 - lib/eco/cli/config/input.rb
 - lib/eco/cli/config/options_set.rb
-- lib/eco/cli/config/people_filters.rb
 - lib/eco/cli/config/use_cases.rb
 - lib/eco/cli/scripting.rb
 - lib/eco/cli/scripting/args_helpers.rb

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

@@ -1,23 +0,0 @@
-module Eco
-  module API
-    class MicroCases
-      #self.define("set_default_tag") do |entry, person, session, options|
-
-      # @param entry [PersonEntry] the input entry with the data we should set on person.
-      # @param person [Person] the person we want to update, carrying the changes to be done.
-      # @param options [Hash] the options
-      def set_default_tag(entry, person, options)
-        unless options.dig(:exclude, :account)
-          unless options.dig(:exclude, :filter_tags) || entry.default_tag?
-            if session.tagtree
-              person.account.default_tag = session.tagtree.default_tag(*person.filter_tags)
-            else
-              tags = person.filter_tags || []
-              person.account.default_tag = tags.first unless tags.length > 1
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,175 +0,0 @@
-module Eco
-  module API
-    class Session
-      # Set of helpers to do most common tasks
-      class Task < API::Common::Session::BaseSession
-        NEWEST_FILE_MODE = [:newest, :last_file, :previous]
-        LOAD_FILE_MODE   = [:file]
-        SAVE_FILE_MODE   = [:save]
-        API_MODE         = [:api, :api_get]
-
-        def file_people(filename = enviro.config.people.cache)
-          logger.info("Going to get all the people via API")
-          people = session.batch.get_people
-          file = file_manager.save_json(people, filename, :timestamp)
-          logger.info("#{people.length} people loaded and saved locally to #{file}.")
-          Eco::API::Organization::People.new(people)
-        end
-
-        def people_refresh(people:, include_created: true)
-          ini = people.length
-          if include_created
-            session.job_groups.find_jobs(type: :create).map do |job|
-              people = people.merge(job.people)
-            end
-          end
-
-          created = people.length - ini
-          msg  = "Going to refresh #{people.length} people with server data"
-          msg += " (including #{created} that were created)" if created > 0
-          session.logger.info(msg)
-          status  = session.batch.get_people(people, silent: true)
-          entries = status.people
-
-          missing = people.length - entries.length
-          session.logger.error("Missed to obtain #{missing} people during the refresh") if missing > 0
-
-          Eco::API::Organization::People.new(status.people)
-        end
-
-        def search(data, options: {}, silent: true)
-          strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
-
-          # to scope people to be fresh data got via api
-          session.logger.info("going to api get #{data.length} entries...")
-
-          status = session.batch.search(data, silent: silent)
-          people = Eco::API::Organization::People.new(status.people)
-
-          # get the supervisors
-          supers = people.each_with_object([]) do |person, sup|
-            if sup_id = person.supervisor_id
-              spr = {"id" => sup_id}
-              sup.push(spr) unless sup.include?(spr) || people.person(id: sup_id, external_id: sup_id)
-            end
-          end
-
-          if supers.length > 0
-            session.logger.info("going to api get #{supers.length} current supervisors...")
-            status = session.batch.search(supers, silent: silent)
-            people = people.merge(status.people, strict: strict_search)
-          end
-
-          supers = data.each_with_object([]) do |entry, sup|
-            if entry.respond_to?(:supervisor_id) && !entry.supervisor_id.to_s.strip.empty?
-              sup_id = entry.supervisor_id
-              spr = {"id" => entry.supervisor_id}
-              sup.push(spr) unless sup.include?(spr) || people.person(id: sup_id, external_id: sup_id)
-            end
-          end
-
-          if supers.length > 0
-            session.logger.info("going to api get #{supers.length} supervisors as per entries...")
-            status = session.batch.search(supers, silent: silent)
-            people = people.merge(status.people, strict: strict_search)
-          end
-
-          session.logger.info("could get #{people.length} people (out of #{data.length} entries)")
-          people
-        end
-
-        def load_people(filename = enviro.config.people.cache, modifier: [:newest, :api])
-          modifier = [modifier].flatten
-          people = []
-          case
-          when !!filename && (load_file?(modifier) || newest_file?(modifier))
-            case
-            when newest_file?(modifier)
-              # search input file based on pattern (in case the name has a timestamp)
-              file = file_manager.dir.newest_file(file: filename)
-              logger.info("previous file found: #{file}") if !!file
-            else
-              file = file_manager.dir.file(filename)
-            end
-
-            if !file
-              logger.error("could not find the file #{file_manager.dir.file(filename)}")
-              exit if !use_api?(modifier)
-              people = self.load_people(modifier: modifier - NEWEST_FILE_MODE - LOAD_FILE_MODE)
-            else
-              people = file_manager.load_json(file)
-              if !!people && people.is_a?(Array)
-                logger.info("#{people&.length} people loaded from file #{file}")
-              end
-            end
-          when use_api?(modifier)
-            # no previous file: use API to get all people
-            logger.info("Going to get all the people via API")
-            people = session.batch.get_people
-
-            if save_file?(modifier) && people && people.length > 0
-              file = file_manager.save_json(people, filename, :timestamp)
-              logger.info("#{people.length } people saved to file #{file}.")
-            end
-          end
-          Eco::API::Organization::People.new(people)
-        end
-
-        def s3upload_targets
-          [].tap do |paths|
-            session.config.s3storage.target_files.each_with_object(paths) do |file, arr|
-              arr.push(session.s3upload(file: file))
-            end
-            session.config.s3storage.target_directories.each_with_object(paths) do |folder, arr|
-              arr.concat(session.s3upload(directory: folder))
-            end
-            session.config.s3storage.target_file_patterns.each_with_object(paths) do |pattern, arr|
-              filenames = []
-              case pattern
-              when Regexp
-                Dir.entries(".").sort.each do |file|
-                  next unless File.file?(file) # Skip directories
-                  filenames.push(file) if file =~ pattern
-                end
-              when String
-                Dir.glob(pattern).sort.each do |file|
-                  next unless File.file?(file) # Skip directories
-                  filenames.push(file)
-                end
-              else
-                # missconfiguration
-              end
-              filenames.each do |file|
-                arr.push(session.s3upload(file: file))
-              end
-            end
-          end
-        end
-
-        private
-
-        # MODIFIERS
-        def use_api?(modifier)
-          modifiers = [modifier].flatten
-          modifiers.any? { |m| API_MODE.include?(m) }
-        end
-
-        def load_file?(modifier)
-          modifiers = [modifier].flatten
-          modifiers.any? { |m| LOAD_FILE_MODE.include?(m) }
-        end
-
-        def newest_file?(modifier)
-          modifiers = [modifier].flatten
-          modifiers.any? { |m| NEWEST_FILE_MODE.include?(m) }
-        end
-
-        def save_file?(modifier)
-          modifiers = [modifier].flatten
-          modifiers.any? { |m| SAVE_FILE_MODE.include?(m) }
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-module Eco
-  module API
-    class UseCases
-      class DefaultCase
-
-        def initialize(cases, **options)
-          raise "Expected a Eco::API::UseCases object. Given #{cases.class}" if !cases.is_a?(Eco::API::UseCases)
-          @cases   = cases
-          @options = options
-        end
-
-        def process
-          raise "You should reimplement this method"
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-module Eco
-  module API
-    class UseCases
-      class DefaultCases
-        class DeleteCase < DefaultCase
-
-          def process
-            @cases.define("delete", type: :transform) do |people, session, options, usecase|
-              delete = session.job_group("main").new("delete", usecase: usecase, type: :delete, sets: [:core, :details, :account])
-              people.each_with_index do |person, i|
-                delete.add(person)
-              end
-            end
-
-            @cases.define("delete", type: :sync) do |entries, people, session, options, usecase|
-              delete = session.job_group("main").new("delete", usecase: usecase, type: :delete, sets: [:core, :details, :account])
-              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
-              entries.each_with_index do |entry, i|
-                if person = people.find(entry, strict: strict_search)
-                  delete.add(person)
-                else
-                  session.logger.error("Entry(#{i}) - this person does not exist: #{entry.to_s(:identify)}")
-                end
-              end
-            end
-          end
-
-        end
-      end
-    end
-  end
-end

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

@@ -1,99 +0,0 @@
-module Eco
-  module API
-    class UseCases
-      class DefaultCases
-        class RecoverDBCase < DefaultCase
-
-          def process
-            @cases.define("recover-db", type: :sync) do |entries, people, session, options, usecase|
-              unless entries.is_a?(Eco::API::Organization::People)
-                raise "Your input should be an 'Eco::API::Organization::People' object. Got: #{entries.class}"
-              end
-
-              if options.dig(:include, :create)
-                creation = session.job_group("main").new("create", usecase: usecase, type: :create, sets: [:core, :details, :account])
-              end
-
-              update   = session.job_group("main").new("update", usecase: usecase, type: :update, sets: [:core, :details, :account])
-
-              if options.dig(:include, :delete)
-                remove   = session.job_group("main").new("remove", usecase: usecase, type: :delete, sets: [:core, :details, :account])
-                people.exclude(entries).map {|person| remove.add(person)}
-              end
-
-              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
-              pgs = session.policy_groups
-
-              not_exist = []
-
-              entries.each.with_index do |entry, i|
-                create = ! (person = people.find(entry, strict: strict_search))
-
-                if create && !options.dig(:include, :create)
-                  not_exist.push(entry);
-                else
-                  person = session.new_person if create
-
-                  unless options.dig(:exclude, :core)
-                    person.external_id   = entry.external_id   unless options.dig(:exclude, :external_id)
-                    person.name          = entry.name          unless options.dig(:exclude, :name)
-                    person.email         = entry.email         unless options.dig(:exclude, :email)
-                    person.supervisor_id = entry.supervisor_id unless options.dig(:exclude, :supervisor)
-                    person.filter_tags   = entry.filter_tags || [] unless options.dig(:exclude, :filter_tags)
-                    person.freemium      = entry.freemium
-                  end
-
-                  unless options.dig(:exclude, :account)
-                    #person.account = entry.account
-                    if eaccount = entry.account
-                      person.account ||= {}
-                      person.account.default_tag          = eaccount.default_tag  unless options.dig(:exclude, :filter_tags)
-
-                      unless options.dig(:exclude, :policy_groups) && person.account.policy_group_ids
-                        person.account.policy_group_ids   = eaccount.policy_group_ids
-                      end
-
-                      unless options.dig(:exclude, :abilities) && (person.account.permissions_preset || person.account.permissions_custom)
-                        person.account.permissions_preset = eaccount.permissions_preset if eaccount.permissions_preset
-                        person.account.permissions_custom = eaccount.permissions_custom
-                      end
-                      person.account.login_provider_ids = eaccount.login_provider_ids if eaccount.login_provider_ids
-                      person.account.accept_eula        = eaccount.accept_eula if eaccount.accept_eula
-
-                      if eaccount.preferences
-                        person.account.doc["preferences"] = JSON.parse((eaccount.doc["preferences"] || {}).to_json)
-                      end
-
-                      person.account.starred_ids        = eaccount.starred_ids     if eaccount.landing_page_id
-                      person.account.landing_page_id    = eaccount.landing_page_id if eaccount.landing_page_id
-
-                      person.account&.send_invites = options[:send_invites] if options.key?(:send_invites)
-                    end
-                  end
-
-                  unless options.dig(:exclude, :details)
-                    person.details = entry.details
-                  end
-
-                  creation.add(person) if create
-                  update.add(person) unless create
-                end
-              end
-
-              unless not_exist.empty?
-                session.logger.error("There were #{not_exist.length} entries of the back up that do not exist in the (filtered?) people manager")
-                session.logger.error("Some examples:")
-                not_exist.slice(0, 4).each_with_index do |entry, i|
-                  session.logger.error("Entry(#{i}) - this person does not exist: #{entry.name} (#{entry.email})")
-                end
-              end
-
-            end
-          end
-
-        end
-
-      end
-    end
-  end
-end