eco-helpers 2.5.10 → 2.6.1

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

@@ -40,19 +40,26 @@ module Eco
         # @option kargs [Eco::API::Organization::People] :people object.
         # @option kargs [Eco::API:Session] :session
         # @option kargs [Hash] :options hash with symbol keys (i.e. behaviour modifiers, cli trackers, filters, etc.)
+        # @return [Eco::API::UseCases::UseCaseIO] an io with the result in output
         def launch(io: nil, **kargs)
           params = io&.params(keyed: true, all: true) || {}
           kargs  = params.merge(kargs).merge(usecase: self)
 
           UseCaseIO.new(**kargs).tap do |uio|
-            @options   = uio.options
+            @options = uio.options
             uio.session.logger.debug("#{self.class}: going to process '#{name}'")
-            set_session_n_options(session: uio.session, options: uio.options) if callback_from_loader?
-            uio.output = @callback.call(*uio.params)
+            set_session_n_options(uio) if callback_from_loader?
+            uio.output = callback.call(*uio.params)
             @times_launched += 1
           end
         end
 
+        # When it was defined from a Loader class it retrieves the object.
+        # @return [Eco::API::Common::Loaders::Base, NilClass]
+        def classed_definition
+          callback_self if callback_from_loader?
+        end
+
         protected
 
         def callback
@@ -60,7 +67,7 @@ module Eco
         end
 
         def callback_self
-          eval("self", @callback.binding)
+          eval("self", callback.binding)
         end
 
         def callback_from_loader?
@@ -71,15 +78,32 @@ module Eco
         # in the use case definition
         # @note this only works when the use case was defined
         #   via an children class of `Eco::API::Common::Loaders::Base`
-        def set_session_n_options(session:, options: @options)
+        def set_session_n_options(uio)
           return false unless callback_from_loader?
+          opts = uio.options || @options
+          sess = uio.session
+          peo  = uio.people
+          ent  = uio.input
           use_case_self = self
+
           callback_self.instance_eval do
-            @session = session
-            @options = options
+            @session = sess
+            @options = opts
+            if peo
+              @people = peo
+              self.singleton_class.attr_reader(:people) unless respond_to?(:people)
+            end
+
+            if ent # entries/input
+              @input = ent
+              self.singleton_class.attr_reader(:input) unless respond_to?(:input)
+            end
+
             # `self` is the use case itself (when used the Loader)
             next unless self.is_a?(Eco::API::Common::Loaders::CaseBase)
+
             @usecase = use_case_self
+            self.singleton_class.attr_reader(:usecase) unless respond_to?(:usecase)
           end
           true
         end

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

@@ -56,12 +56,12 @@ module Eco
           end
         end
 
-        def chain(usecase = nil)
+        def chain(usecase = nil, &block)
           @@num_chains += 1
           raise "Reached maximum number of chained use cases (#{MAX_CHAINS}). Looks like a recursive cyclic chain 'use'" if @@num_chains >= MAX_CHAINS
           raise "A UseCase can only be chained with another UseCase" if usecase && !usecase.is_a?(UseCase)
           raise "Missuse. Please use either parameter or block but not both" if block_given? && usecase
-          usecase = block_given?? Proc.new : usecase
+          usecase = block_given?? block : usecase
           @chains.push(usecase)
           self
         end

data/lib/eco/api/usecases.rb

@@ -1,5 +1,6 @@
 module Eco
   module API
+    # Autoloading children is done on init and each time usecases it's queried
     class UseCases
 
       class UnknownCase < StandardError
@@ -161,7 +162,9 @@ require_relative 'usecases/use_case'
 require_relative 'usecases/use_case_chain'
 require_relative 'usecases/base_io'
 require_relative 'usecases/use_case_io'
+require_relative 'usecases/cli'
 require_relative 'usecases/default_cases'
+require_relative 'usecases/graphql'
 require_relative 'usecases/ooze_samples'
 require_relative 'usecases/ooze_cases'
-require_relative 'usecases/graphql'
+require_relative 'usecases/default'

data/lib/eco/assets.rb

@@ -31,18 +31,16 @@ module Eco
       @configs ||= {}
     end
 
-    def cli
+    def cli(&block)
       unless @cli_init
         @cli_init = true
-        #pp "going to load default cli config..."
-        require_relative('cli/config/default')
+        require_relative('cli_default')
       end
-      @cli
+      @cli.tap { yield(@cli) if block_given? }
     end
   end
 end
 
 require_relative 'assets/language'
 
-
 ASSETS = Eco::Assets.new

data/lib/eco/cli/config/filters/people_filters.rb

@@ -22,7 +22,6 @@ module Eco
             end
             io.people
           end
-
         end
       end
     end

data/lib/eco/cli/config/filters.rb

@@ -28,9 +28,9 @@ module Eco
 
         # @param option [String] the command line option that activates this filter.
         # @param desc [String] description of the filter.
-        def add(option, desc = nil)
+        def add(option, desc = nil, &block)
           raise "Missing block to define the filters builder" unless block_given?
-          callback = Proc.new
+          callback = block
           [option].flatten.compact.each do |opt|
             @filters[opt]     = callback
             @description[opt] = desc
@@ -41,10 +41,6 @@ module Eco
         def process(io:)
           raise "You need to override this method in child classes"
         end
-
-        private
-
-
       end
     end
   end

data/lib/eco/cli/config/help.rb

@@ -43,7 +43,6 @@ module Eco
             end
           end
         end
-
       end
     end
   end

data/lib/eco/cli/config/input.rb

@@ -33,7 +33,6 @@ module Eco
           callback = @callbacks[option] || @callbacks[default_option]
           callback.call(io.session, option, io.options)
         end
-
       end
     end
   end

data/lib/eco/cli/config/options_set.rb

@@ -44,14 +44,14 @@ module Eco
         # @param option [String, Array<String>] the command line option(s).
         # @param namespace [String] preceding command(s) argument that enables this option.
         # @param desc [String] description of the option.
-        def add(option, desc = nil, namespace: :general)
+        def add(option, desc = nil, namespace: :general, &block)
           raise "Missing block to define the options builder" unless block_given?
 
           opts = [option].flatten.compact
           unless opts.empty?
-            callback = Proc.new
+            callback = block
             opts.each do |opt|
-              puts "Overriding option '#{option}' in '#{namespace}' namespace" if option_exists?(opt, namespace)
+              puts "Overriding CLI option '#{option}' in '#{namespace}' CLI case / namespace" if option_exists?(opt, namespace)
               options_set(namespace)[opt] = OptConfig.new(opt, namespace, desc, callback)
             end
           end
@@ -139,7 +139,6 @@ module Eco
         def options_set(namespace = :general)
           @sets[namespace] ||= {}
         end
-
       end
     end
   end

data/lib/eco/cli/config/use_cases.rb

@@ -6,7 +6,6 @@ module Eco
         attr_reader :core_config
 
         class CaseConfig < Struct.new(:cases_config, :option, :type, :description, :casename, :callback)
-
           def add_option(arg, desc = nil, &block)
             core_config.options_set.add(arg, desc, namespace: option, &block)
             self
@@ -20,7 +19,6 @@ module Eco
         end
 
         class ActiveCase < Struct.new(:index, :option, :callback)
-
         end
 
         def initialize(core_config:)
@@ -47,16 +45,26 @@ module Eco
         # @param type [Symbol] the type of usecase.
         # @param desc [String] description of the case.
         # @param case_name [String, nil] the name of the usecase as defined.
-        def add(option_case, type, desc = nil, case_name: nil)
+        def add(option_case, type, desc = nil, case_name: nil, &callback)
           Eco::API::UseCases::UseCase.validate_type(type)
-          unless callback = block_given?? Proc.new : nil
+          unless block_given?
             raise "You must specify a valid 'case_name' when no block is provided" unless case_name
             raise "'case_name' expected to be a String. Given: #{case_name.class}" unless case_name.is_a?(String)
           end
-          puts "Overriding case config '#{option_case}'" if @linked_cases.key?(option_case)
+          puts "Overriding CLI case '#{option_case}'" if @linked_cases.key?(option_case)
           @linked_cases[option_case] = CaseConfig.new(self, option_case, type, desc, case_name, callback)
         end
 
+        # This method runs on use cases that have lazy configurations
+        # @note it only applies to use cases that have been defined via class
+        def cli_apply(io:)
+          io.session.usecases.each do |usecase|
+            next unless usecase.respond_to?(:classed_definition)
+            next unless original_case = usecase.classed_definition
+            original_case.cli_apply!
+          end
+        end
+
         # Scopes/identifies which usecases are being invoked from the command line
         # @note
         #   - this method will sort the active usecases by the position they hold in the command line
@@ -126,7 +134,6 @@ module Eco
             raise "You need to provide Eco::API::UseCases::BaseIO object. Given: #{io.class}"
           end
         end
-
       end
     end
   end

data/lib/eco/cli/config.rb

@@ -23,19 +23,19 @@ module Eco
         end
       end
 
-      def input(default_option: nil)
+      def input(default_option: nil, &block)
         @input ||= Eco::CLI::Config::Input.new(core_config: self, default_option: default_option)
         if block_given?
-          @input.define(&Proc.new)
+          @input.define(&block)
           self
         else
           @input
         end
       end
 
-      def people(io: nil)
+      def people(io: nil, &block)
         if block_given?
-          @people_load = Proc.new
+          @people_load = block
           self
         else
           raise "There is no definition on how to load people" unless instance_variable_defined?(:@people_load) && @people_load
@@ -68,7 +68,6 @@ module Eco
           yield(cases) if block_given?
         end
       end
-
     end
   end
 end

data/lib/eco/cli/scripting/args_helpers.rb

@@ -88,7 +88,7 @@ module Eco
         private
 
         def file_exists?(filename)
-          File.exists?(filename) || File.exists?(File.expand_path(filename))
+          File.exist?(filename) || File.exist?(File.expand_path(filename))
         end
       end
     end

data/lib/eco/cli/scripting/argument.rb

@@ -31,7 +31,6 @@ module Eco
         def with_param?
           @with_param
         end
-        
       end
     end
   end

data/lib/eco/cli/scripting/arguments.rb

@@ -62,8 +62,6 @@ module Eco
             "Missuse: only able to transform to key a String or an Argument. Given #{value.class}"
           end
         end
-
-
       end
     end
   end

data/lib/eco/cli.rb

@@ -24,7 +24,6 @@ module Eco
       io = Eco::API::UseCases::BaseIO.new(session: session, options: options)
       session.workflow(io: io).run(io: io)
     end
-
   end
 end
 

data/lib/eco/{cli/config/default → cli_default}/input_filters.rb

@@ -53,6 +53,5 @@ ASSETS.cli.config do |cnf|
       #end
       input.supervisor_id(id)
     end
-
   end
 end

data/lib/eco/{cli/config/default → cli_default}/people_filters.rb

@@ -103,6 +103,5 @@ ASSETS.cli.config do |cnf|
         people.newFrom filtered
       end
     end
-
   end
 end

data/lib/eco/{cli/config/default → cli_default}/usecases.rb

@@ -17,14 +17,6 @@ ASSETS.cli.config do |cnf|
       options.deep_merge!(output: {file: file})
     end
 
-    desc = "Abstracts the Abilities that each Usergroup should probably have"
-    cases.add("-abstract-policygroup-abilities", :export, desc, case_name: "abstract-policygroup-abilities") do |people, session, options|
-      options.deep_merge!(output: {file: "suggested_usergroup_abilities.txt"}) unless options.dig(:output, :file)
-    end.add_option("-to", "Specify the output file") do |options|
-      file = SCR.get_file("-to", required: true, should_exist: false)
-      options.deep_merge!(output: {file: file})
-    end
-
     desc = "Provides a set of tools to analyse a set of people (i.e. detect duplicates)"
     cases.add("-analyse-people", :export, desc, case_name: "analyse-people") do |people, session, options|
       options.deep_merge!(output: {file: "people_analysis.txt"}) unless options.dig(:output, :file)
@@ -87,14 +79,6 @@ ASSETS.cli.config do |cnf|
       options.deep_merge!(other: {file: {codes_column: col_codes}})
     end
 
-    desc = "Allows to perform some checks on tagtree structure (requires GraphQL)"
-    cases.add("-tagtree", :other, desc, case_name: "tagtree")
-    .add_option("-show-backend", "Displays the tagtree as per back-end") do |options|
-      options.deep_merge!(tagtree: {operation: {show_backend: true}})
-    end.add_option("-diff", "Compares the tagtree.json file with the back-end") do |options|
-      options.deep_merge!(tagtree: {operation: {diff: true}})
-    end
-
     desc = "Creates a CSV with the paths to each tag"
     cases.add("-create-tag-paths", :other, desc, case_name: "create-tag-paths")
 
@@ -107,32 +91,13 @@ ASSETS.cli.config do |cnf|
     desc  = "Cleans from filter_tags those tags that are not present in the tagtree (as per tagtree.json file)."
     desc += " It will preserve standard register tags of most common registers (i.e. EVENT, RISK)."
     cases.add("-clean-unknown-tags", :transform, desc, case_name: "clean-unknown-tags")
-    .add_option("-include-register-tags", "Will also try to remove register tags") do |options|
-      options.deep_merge!(usecase: {include_register_tags: true})
-    end
-
-    desc = "Removes the landing page or sets it to -page-id"
-    cases.add("-reset-landing-page", :transform, desc, case_name: "reset-landing-page")
-    .add_option("-page-id", "Target landing page to set to the users") do |options|
-      SCR.get_arg("-page-id", with_param: true).tap do |new_id|
-        options.deep_merge!({page_id: new_id})
-      end
+    .add_option("-clear-register-tags", "Will also try to remove register tags") do |options|
+      options.deep_merge!(usecase: {clear_register_tags: true})
     end
 
-    desc = "Sets as external_id the email of the person"
-    cases.add("-email-as-id", :transform, desc, case_name: "email-as-id")
-
-    desc = "Sets the external_id to the one given in the input CSV"
-    cases.add("-new-id-from", :sync, desc, case_name: "new-id")
-
-    desc = "Sets the email of people. It won't succeed if email taken by any other user in eP"
-    cases.add("-new-email-from", :sync, desc, case_name: "new-email")
     desc = "Forces a change of email in the same org. It won't succeed if email taken by an org member user"
     cases.add("-change-email-from", :sync, desc, case_name: "change-email")
 
-    desc = "Sets the supervisor_id"
-    cases.add("-set-supervisor-from", :sync, desc, case_name: "set-supervisor")
-
     desc = "Sets to -new-super the supervisor_id of the -old-super's subordinates"
     cases.add("-switch-supervisor", :transform, desc, case_name: "switch-supervisor") do |people, session, options|
       unless options[:super]&.key?(:old)
@@ -218,10 +183,6 @@ ASSETS.cli.config do |cnf|
     cases.add("-delete", :transform, desc, case_name: "delete")
     desc = "Deletes the people specified in the input data"
     cases.add("-delete-from", :sync, desc, case_name: "delete")
-    desc = "Removes the account of everybody that has been filtered from the people manager"
-    cases.add("-remove-account", :transform, desc, case_name: "remove-account")
-    desc = "Removes the people specified in the input data"
-    cases.add("-remove-account-from", :sync, desc, case_name: "remove-account")
 
     desc = "Re-freshes the default_tag of users"
     cases.add("-set-default-tag", :transform, desc, case_name: "set-default-tag")
@@ -234,20 +195,9 @@ ASSETS.cli.config do |cnf|
       options.deep_merge!(people: {append_created: true})
     end
 
-    desc = "Creates people with only details"
-    cases.add("-create-details-from", :sync, desc, case_name: "create-details")
-    .add_option("-append-starters", as1) do |options|
-      options.deep_merge!(people: {append_created: true})
-    end
-
     desc = "It just adds everybody to an update job without doing any change. If the org has policies, it will refresh"
     cases.add("-refresh", :transform, desc, case_name: "refresh")
 
-    desc = "Updates details and core (including supervisor) to target people"
-    cases.add("-update-details-from", :sync, desc, case_name: "update-details")
-
-    desc = "Appends the policy_group_ids column to the people with account specified in the input data"
-    cases.add("-append-usergroups-from", :sync, desc, case_name: "append-usergroups")
     desc = "Updates the people specified in the input data"
     cases.add("-update-from", :sync, desc, case_name: "update")
 

data/lib/eco/cli_default/workflow.rb

@@ -0,0 +1,171 @@
+ASSETS.cli do |cli|
+  ASSETS.config.workflow do |wf|
+
+    rescued = false
+    # default rescue
+    wf.rescue do |err, io|
+      next io if rescued
+      rescued = true
+      log(:debug) { err.patch_full_message }
+      wf.run(:close, io: io)
+    rescue StandardError => e
+      puts "Some problem in workflow.rescue: #{e}"
+    end
+
+    wf.on(:options) do |_wf_opt, io|
+      cli.config.usecases.cli_apply(io: io)
+      io.new(options: cli.config.options_set.process(io: io))
+    end
+
+    wf.for(:load) do |wf_load|
+      wf_load.for(:input) do |wf_in|
+        wf_in.on(:get) do |_wf_ig, io|
+          cases_with_input = cli.config.usecases.active(io: io).select do |usecase, data|
+            io.class.input_required?(usecase.type)
+          end
+
+          input_is_required = !cases_with_input.empty? || options.dig(:input, :entries_from)
+          missing_input     = !input || input.empty?
+          next unless missing_input && input_is_required
+
+          if options.dig(:input, :entries_from)
+            io.new(input: cli.config.input.get(io: io))
+          else
+            opt_case = cases_with_input.values.first.option
+            io.new(input: cli.config.input.get(io: io, option: opt_case))
+          end
+        end
+
+        wf_in.on(:filter) do |_wf_if, io|
+          next unless input && !input.empty?
+          io.new(input:  cli.config.input_filters.process(io: io))
+        end
+      end
+
+      wf_load.for(:people) do |wf_peo|
+        wf_peo.on(:get) do |_wf_pg, io|
+          cases_with_people = cli.config.usecases.active(io: io).select do |usecase, data|
+            io.class.people_required?(usecase.type)
+          end
+          next if cases_with_people.empty? && !options.dig(:people, :get)
+          io.new(people: cli.config.people(io: io))
+        end
+
+        wf_peo.on(:filter) do |_wf_pf, io|
+          next unless people && !people.empty?
+          io.new(people: cli.config.people_filters.process(io: io))
+        end
+      end
+    end
+
+    wf.before(:usecases) do |_wf_ca, io|
+      # save partial entries -> should be native to session.workflow
+      get_people     = options.dig(:people, :get)
+      partial_update = get_people && get_people.dig(:type) == :partial
+      if !options[:dry_run] && partial_update
+        partial_file = session.config.people.partial_cache
+        session.file_manager.save_json(io.people, partial_file, :timestamp)
+      end
+    end
+
+    wf.on(:usecases) do |_wf_ca, io|
+      unless cli.config.usecases.process(io: io)
+        log(:info) { "No update operation specified... quitting" }
+        exit 0
+      end
+    end
+
+    wf.before(:launch_jobs) do
+      SCR.stop_on_unknown!
+    end
+
+    wf.on(:launch_jobs) do
+      session.jobs_launch(simulate: options[:dry_run])
+    end
+
+    wf.before(:post_launch) do |wf_post, io|
+      next wf_post.skip! if session.post_launch.empty?
+
+      run_it  = !options[:dry_run] || options.dig(:post_launch, :run)
+      unless run_it
+        wf_post.skip!
+        log(:info) {
+          msg  = "Although there are post_launch cases, they will NOT be RUN"
+          msg += ", because we are in dry-run (simulate)." if options[:dry_run]
+          msg
+        }
+        next
+      end
+
+      get_people     = options.dig(:people, :get)
+      partial_update = get_people && get_people.dig(:type) == :partial
+      refresh_data   = !options[:dry_run] && partial_update
+
+      unless refresh_data
+        log(:info) {
+          msg = "Although there are post_launch cases, data will not be refreshed before their run"
+          if io.options[:dry_run]
+            msg += ", because we are in dry-run (simulate)."
+          elsif !partial_update
+            msg += ", because it is not a partial update (-get-partial option not present)."
+          end
+          msg
+        }
+        next
+      end
+
+      # get target people afresh
+      peo_aux = session.micro.people_refresh(people: people, include_created: true)
+      io.base.new(people: peo_aux)
+    end
+
+    wf.for(:post_launch) do |wf_post|
+      wf_post.on(:usecases) do |_wf_pu, io|
+        session.post_launch.each do |use|
+          use.launch(io: io).base
+        rescue Eco::API::UseCases::BaseIO::MissingParameter => e
+          raise unless e.required == :people
+          log(:debug) {
+            "Skipping use case '#{use.name}' -- no base people detected for the current run"
+          }
+        end
+      end
+
+      wf_post.on(:launch_jobs) do |_wf_pl, io|
+        session.jobs_launch(simulate: options[:dry_run])
+      end
+    end
+
+    wf.on(:report) do |_wf_rep, io|
+      if file = options.dig(:report, :people, :csv)
+        options.deep_merge!(export: {
+          options: {internal_names: true, nice_header: true, split_schemas: true},
+          file:    {name: file, format: :csv}
+        })
+        aux_io = io.new(people: people.updated_or_created)
+        session.process_case("to-csv", io: aux_io, type: :export)
+      end
+    end
+
+    wf.on(:end) do |_wf_end, io|
+      get_people     = options.dig(:people, :get)
+      partial_update = get_people && get_people.dig(:type) == :partial
+
+      unless !options[:end_get] || options[:dry_run] || partial_update
+        people_update_cases = cli.config.usecases.active(io: io).any? do |usecase, data|
+          [:transform, :sync].any? { |type| usecase.type == type }
+        end
+
+        if !people_update_cases
+          # Prevent getting people when there were no use cases that used them
+          log(:info) {
+            "Won't be recaching people, as there haven't been any targetted updates"
+          }
+        elsif !people
+          people = session.micro.people_cache
+          io.new(people: people)
+        end
+      end
+    end
+  end
+end

data/lib/eco/cli_default.rb

@@ -0,0 +1,13 @@
+# Invoked / required when dependencies have been already loaded (i.e. Eco::API, Eco:Assets, Eco::Cli)
+module Eco
+  module CliDefault
+  end
+end
+
+require_relative 'cli_default/options'
+require_relative 'cli_default/input'
+require_relative 'cli_default/input_filters'
+require_relative 'cli_default/people'
+require_relative 'cli_default/people_filters'
+require_relative 'cli_default/usecases'
+require_relative 'cli_default/workflow'

data/lib/eco/csv/table.rb

@@ -142,7 +142,6 @@ module Eco
       end
 
       # @note by default it adds as a first column
-
       # @param header_name [String] header of the new column
       # @param pos [Integer] index where to add the column (i.e. `-1` for last)
       # @return [Eco::CSV::Table] with a new column named `name` with the row number

data/lib/eco/data/files/encoding.rb

@@ -62,7 +62,7 @@ module Eco
 
         def file_exists?(file)
           return false if !file
-          return File.exists?(file) || File.exists?(File.expand_path(file))
+          return File.exist?(file) || File.exist?(File.expand_path(file))
         end
 
         def file_empty?(path)

data/lib/eco/data/files/helpers.rb

@@ -68,7 +68,7 @@ module Eco
 
         def file_exists?(file)
           return false if !file
-          return File.exists?(file) || File.exists?(File.expand_path(file))
+          return File.exist?(file) || File.exist?(File.expand_path(file))
         end
 
         def dir_exists?(path)