eco-helpers 1.5.1 → 1.5.6

data/lib/eco/language/models/parser_serializer.rb

@@ -1,29 +1,32 @@
 module Eco
   module Language
     module Models
-
+      # Basic class to define a parser/serializing framework
+      # @attr_reader attr [String, Symbol] the attribute this parser/serializer is linked to.
       class ParserSerializer
-
         attr_reader :attr
 
         # Parser/seralizer.
         # @param attr [String, Symbol] name of the parsed/serialized.
         # @param dependencies [Hash] provisioning of _**default dependencies**_ that will be required when calling back to the
-        # parsing or serializing functions.
+        #   parsing or serializing functions.
         def initialize(attr, dependencies: {})
-          @attr = attr
+          @attr         = attr
           @dependencies = dependencies
+          @parser       = {}
+          @serializer   = {}
         end
 
         # Defines the _parser_ of the attribute.
         # @note
         #   1. the _block_ should expect one or two parameters.
         #   2. the final dependencies is a merge of _default dependencies_ with `parse` call dependencies.
+        # @param category [Symbol] a way to classify multiple parsers by category.
         # @yield [source_data, dependencies] user defined parser that returns the parsed value.
         # @yieldparam source_data [Any] source data that will be parsed.
         # @yieldparam dependencies [Hash] hash with the provisioned dependencies.
-        def def_parser(&block)
-          @parser = block
+        def def_parser(category = :default, &block)
+          @parser[category.to_sym] = block
           self
         end
 
@@ -31,11 +34,12 @@ module Eco
         # @note
         #   1. the block should expect one or two parameters.
         #   2. the final dependencies is a merge of _default dependencies_ with `serialize` call dependencies.
+        # @param category [Symbol] a way to classify multiple serializers by category.
         # @yield [source_data, dependencies] user defined serialiser that returns the serialised value.
         # @yieldparam source_data [Any] source data that will be serialised.
         # @yieldparam dependencies [Hash] hash with the provisioned dependencies.
-        def def_serializer(&block)
-          @serializer = block
+        def def_serializer(category = :default, &block)
+          @serializer[category.to_sym] = block
           self
         end
 
@@ -45,9 +49,9 @@ module Eco
         # @raise [Exception] when there is **no** `parser` defined.
         # @param source [Any] source data to be parsed.
         # @param dependencies [Hash] _additional dependencies_ that should be merged to the _default dependencies_.
-        def parse(source, dependencies: {})
-          raise "There is no parser for this attribue '#{attr}'" if !@parser
-          @parser.call(source, @dependencies.merge(dependencies), attr)
+        def parse(source, category = :default, dependencies: {})
+          raise "There is no parser of type '#{category}' for this attribue '#{attr}'" unless parser_category?(category)
+          call_block(source, @dependencies.merge(dependencies), attr, &@parser[category.to_sym])
         end
 
         # Calls the `serializer` of this attribute by passing `object` and resolved dependencies.
@@ -56,13 +60,33 @@ module Eco
         # @raise [Exception] when there is **no** `serializer` defined.
         # @param object [Any] source data to be serialized.
         # @param dependencies [Hash] _additional dependencies_ that should be merged to the _default dependencies_.
-        def serialize(object, dependencies: {})
-          raise "There is no serializer for this attribue '#{attr}'" if !@serializer
-          @serializer.call(object, @dependencies.merge(dependencies), attr)
+        def serialize(object, category = :default, dependencies: {})
+          raise "There is no serializer of type '#{category}' for this attribue '#{attr}'" unless serializer_category?(category)
+          call_block(object, @dependencies.merge(dependencies), attr, &@serializer[category.to_sym])
         end
 
-      end
+        # Checks if there's a `parser` defined for `category`
+        # @return [Boolean] `true` if the parser is defined, and `false` otherwise
+        def parser_category?(category = :default)
+          @parser.key?(category.to_sym)
+        end
+
+        # Checks if there's a `serializer` defined for `category`
+        # @return [Boolean] `true` if the serializer is defined, and `false` otherwise
+        def serializer_category?(category = :default)
+          @serializer.key?(category.to_sym)
+        end
+
+        private
 
+        # The methods may expect less parameters from some type of parsers.
+        #   Here, we ensure they are called with the expected number of parameters.
+        def call_block(*args, &block)
+          params = block.parameters.zip(args).map(&:last)
+          yield(*params)
+        end
+
+      end
     end
   end
 end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "1.5.1"
+  VERSION = "1.5.6"
 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.6
 platform: ruby
 authors:
 - Oscar Segura
@@ -116,7 +116,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.7.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
@@ -126,7 +126,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.7.3
     - - "<"
       - !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,40 @@ 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/common/version_patches/object.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 +366,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 +387,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 +412,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 +420,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