eco-helpers 3.0.37 → 3.1.1

data/lib/eco/cli_default/options.rb

@@ -1,6 +1,6 @@
 ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
   cnf.options_set do |options_set, top_opts| # rubocop:disable Metrics/BlockLength
-    options_set.add('--help', 'Offers a HELP') do |options, _sess|
+    options_set.add('--help', 'Offers a HELP') do |_opts, _sess|
       conf   = ASSETS.cli.config
 
       active = proc do |opt|
@@ -54,6 +54,67 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       $stdout.reopen(file, 'w+')
     end
 
+    desc = 'Runs in dry-run (no requests sent to server)'
+    options_set.add(['-dry-run', '-simulate'], desc) do |options, session|
+      options[:dry_run]  = true
+      options[:simulate] = true
+      session.config.dry_run!
+    end
+
+    desc  = 'Specifies the target API key space (i.e. uat, dev, etc.). '
+    desc << 'Use with CAUTION !!!'
+    options_set.add('-space', desc) do |options, _sess|
+      next unless (space = SCR.get_arg('-space', with_param: true))
+
+      options.deep_merge!(api: {space: space.to_sym})
+    end
+
+    desc = "It specifies the type of batch to be used (default: ':batch')"
+    options_set.add('-batch-mode', desc) do |options, session|
+      mode_in  = SCR.get_arg('-batch-mode', with_param: true)
+      mode_str = mode_in.to_s.downcase
+      mode_sym = %i[batch job].find do |md|
+        next true if md.to_s == mode_str
+
+        md.to_s == mode_str.gsub(':', '')
+      end
+
+      unless mode_sym
+        session.log(:warn) {
+          "Unknown job_mode: #{mode_in}. Switching to default: ':batch'"
+        }
+        mode_sym = :batch
+      end
+
+      options.deep_merge!(workflow: {batch: {mode: mode_sym}})
+    end
+
+    # EMAIL NOTIFICATIONS & INVITES
+
+    desc = 'Prevent email to be sent'
+    options_set.add('-no-email', desc) do |options|
+      options.deep_merge!(workflow: {no_email: true})
+    end
+
+    desc = 'Do not prevent email notification when not in remote or when in dry run'
+    options_set.add('-notify', desc) do |options|
+      options.deep_merge!(workflow: {notify: true})
+      options.deep_merge!(workflow: {no_mail: false})
+    end
+
+
+    desc = 'Silence notifications on account creation or invites'
+    options_set.add(['-no-invites', '-exclude-invites'], desc) do |options|
+      options.merge!(send_invites: false)
+    end
+
+    desc = "People with account will be reinvited if they haven't accepted the invitation"
+    options_set.add('-send-invites', desc) do |options|
+      options.merge!(send_invites: true)
+    end
+
+    # CSV
+
     desc = 'Skips the check of the headers'
     options_set.add('-skip-header-check', desc) do |options, _sess|
       options.deep_merge!(input: {header_check: {skip: true}})
@@ -69,26 +130,7 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       options.deep_merge!(input: {header_check: {must_be_valid: true}})
     end
 
-    desc = 'Fix the current session to work with this schema'
-    options_set.add('-schema-id', desc) do |options, session|
-      sch_name = SCR.get_arg('-schema-id', with_param: true)
-      sch_id   = session.schemas.to_id(sch_name)
-
-      unless sch_id
-        msg = 'You need to specify a correct schema id or name. '
-        msg << "'#{sch_name}' does not exist. Correct options are: "
-        msg << session.schemas.map(&:name).join(', ')
-
-        session.log(:error) { msg }
-        exit(1)
-      end
-
-      options.deep_merge!(people: {filter: {details: {schema_id: sch_id}}})
-      session.log(:info) {
-        "Setting schema #{session.schemas.to_name(sch_id)}"
-      }
-      session.schema = sch_id
-    end
+    # INPUT MODIFIERS
 
     desc  = 'Used to be used to specify the input file or folder when using -get-partial. '
     desc << 'It can also be useful to obtain `-get-partial` of people base on `:export` use cases (i.e. -people-to-csv)'
@@ -98,11 +140,13 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
 
     desc = 'Used to specify the input file encoding'
     options_set.add('-input-encoding', desc) do |options, _sess|
-      if encoding = SCR.get_arg('-input-encoding', with_param: true)
+      if (encoding = SCR.get_arg('-input-encoding', with_param: true))
         options.deep_merge!(input: {file: {encoding: encoding}})
       end
     end
 
+    # PEOPLE FETCH
+
     desc = 'Do not load any people for this run.'
     options_set.add('-no-people', desc) do |options, _sess|
       options.deep_merge!(people: {
@@ -131,11 +175,6 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       })
     end
 
-    desc = "Saves the requests's body even though running in dry-run (-simulate)"
-    options_set.add('-save-requests', desc) do |options, _sess|
-      options.deep_merge!(requests: {backup: true})
-    end
-
     desc  = 'Used to specify the cache file of people to be used. '
     desc << 'It is useful to use as people reference those stored in cached file diffrent to the last one.'
     options_set.add('-people-from-backup', desc) do |options, _sess|
@@ -156,46 +195,45 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       options.deep_merge!(report: {people: {csv: file}})
     end
 
-    desc = 'Runs in dry-run (no requests sent to server)'
-    options_set.add(['-dry-run', '-simulate'], desc) do |options, session|
-      options[:dry_run]  = true
-      options[:simulate] = true
-      session.config.dry_run!
-    end
-
-    desc  = 'Specifies the target API key space (i.e. uat, dev, etc.). '
-    desc << 'Use with CAUTION !!!'
-    options_set.add('-space', desc) do |options, _sess|
-      next unless (space = SCR.get_arg('-space', with_param: true))
+    # Filter by schema
 
-      options.deep_merge!(api: {space: space.to_sym})
-    end
+    desc = 'Fix the current session to work with this schema'
+    options_set.add('-schema-id', desc) do |options, session|
+      sch_name = SCR.get_arg('-schema-id', with_param: true)
+      sch_id   = session.schemas.to_id(sch_name)
 
-    desc = "It specifies the type of batch to be used (default: ':batch')"
-    options_set.add('-batch-mode', desc) do |options, session|
-      mode_in  = SCR.get_arg('-batch-mode', with_param: true)
-      mode_str = mode_in.to_s.downcase
-      mode_sym = %i[batch job].find do |md|
-        next true if md.to_s == mode_str
+      unless sch_id
+        msg = 'You need to specify a correct schema id or name. '
+        msg << "'#{sch_name}' does not exist. Correct options are: "
+        msg << session.schemas.map(&:name).join(', ')
 
-        md.to_s == mode_str.gsub(':', '')
+        session.log(:error) { msg }
+        exit(1)
       end
 
-      unless mode_sym
-        session.log(:warn) {
-          "Unknown job_mode: #{mode_in}. Switching to default: ':batch'"
-        }
-        mode_sym = :batch
-      end
+      options.deep_merge!(people: {filter: {details: {schema_id: sch_id}}})
+      session.log(:info) {
+        "Setting schema #{session.schemas.to_name(sch_id)}"
+      }
+      session.schema = sch_id
+    end
 
-      options.deep_merge!(workflow: {batch: {mode: mode_sym}})
+    # REQUESTS
+
+    desc = "Saves the requests's body even though running in dry-run (-simulate)"
+    options_set.add('-save-requests', desc) do |options, _sess|
+      options.deep_merge!(requests: {backup: true})
     end
 
+    # WORKFLOW
+
     desc = 'Runs runs post_launch cases even if in dry-run'
     options_set.add('-run-postlaunch', desc) do |options, _sess|
       options.deep_merge!(post_launch: {run: true})
     end
 
+    # INCLUDED
+
     desc  = '(careful with this option)  This will include everybody as part of the update '
     desc << '(including those that are api excluded). '
     desc << 'Only launch with this option when only api excluded people are included in your update.'
@@ -208,6 +246,8 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       options.deep_merge!(include: {excluded: {only: true}})
     end
 
+    # BATCH POLCIY & API POLICIES
+
     desc = 'Ignores threshold limitations on requests for this session (skip batch belt)'
     options_set.add('-skip-batch-policy', desc) do |options|
       options.deep_merge!(skip: {batch_policy: true})
@@ -218,10 +258,14 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       options.deep_merge!(skip: {api_policies: true})
     end
 
+    # FEEDBACK
+
     options_set.add('-feed-only-stats', 'Shows only stats when giving feedback') do |options|
       options.deep_merge!(feedback: {only_stats: true})
     end
 
+    # STRICT/SOFT SEARCH MATCH
+
     desc  = "Force search mode to 'strict' when pairing input entries with existing people."
     desc << ' Besides id and external_id it will not try to find by email unless external_id is not specified'
     options_set.add('-search-strict', desc) do |options|
@@ -238,20 +282,6 @@ ASSETS.cli.config do |cnf| # rubocop:disable Metrics/BlockLength
       })
     end
 
-    desc = 'Prevent email to be sent (experimental)'
-    options_set.add('-no-email', desc) do |options|
-      options.deep_merge!(workflow: {no_email: true})
-    end
-
-    desc = 'Silence notifications on account creation or invites'
-    options_set.add(['-no-invites', '-exclude-invites'], desc) do |options|
-      options.merge!(send_invites: false)
-    end
-    desc = "People with account will be reinvited if they haven't accepted the invitation"
-    options_set.add('-send-invites', desc) do |options|
-      options.merge!(send_invites: true)
-    end
-
     # EXCLUDE CORE
 
     options_set.add('-exclude-core', 'Core input data is not used on the update') do |options|

data/lib/eco/cli_default/workflow/end.rb

@@ -0,0 +1,22 @@
+class Eco::CliDefault::Workflow
+  class End < Eco::API::Common::Loaders::Workflow
+    config_block(:workflow, :end) do
+      on(:end) do
+        get_people     = options.dig(:people, :get)
+        partial_update = get_people && get_people[:type] == :partial
+
+        unless !options[:end_get] || options[:dry_run] || partial_update
+          if !some_update_case?(io)
+            # 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(data: people)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/cli_default/workflow/launch_jobs.rb

@@ -0,0 +1,14 @@
+class Eco::CliDefault::Workflow
+  class LaunchJobs < Eco::API::Common::Loaders::Workflow
+    config_block(:workflow, :launch_jobs) do
+      before(:launch_jobs) do
+        available_args = cli.config.available_option_args
+        SCR.stop_on_unknown!(all_available: available_args)
+      end
+
+      on(:launch_jobs) do
+        session.jobs_launch(simulate: options[:dry_run])
+      end
+    end
+  end
+end

data/lib/eco/cli_default/workflow/load/data.rb

@@ -0,0 +1,27 @@
+class Eco::CliDefault::Workflow::Load
+  class Data < Eco::API::Common::Loaders::Workflow
+    config_block(:workflow, :load, :data) do
+      with(:load) do |wf_load|
+        wf_load.before(:data) do
+          # @todo model should be set to the target model
+          #   based on the main use case that requires data!
+          io.new(model: :people)
+        end
+
+        wf_load.with(:data) do |wf_peo|
+          wf_peo.on(:get) do
+            next unless some_data_case?(io) || options.dig(:people, :get)
+
+            io.new(data: cli.config.people(io: io))
+          end
+
+          wf_peo.on(:filter) do
+            next unless data && !data.empty?
+
+            io.new(data: cli.config.people_filters.process(io: io))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/cli_default/workflow/load/input.rb

@@ -0,0 +1,28 @@
+class Eco::CliDefault::Workflow::Load
+  class Input < Eco::API::Common::Loaders::Workflow
+    config_block(:workflow, :load, :input) do
+      with(:load) do |wf_load|
+        wf_load.with(:input) do |wf_in|
+          wf_in.on(:get) do
+            input_is_required = some_input_case?(io) || 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 = cli_input_cases(io).values.first.option
+              io.new(input: cli.config.input.get(io: io, option: opt_case))
+            end
+          end
+
+          wf_in.on(:filter) do
+            next unless input && !input.empty?
+
+            io.new(input: cli.config.input_filters.process(io: io))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/cli_default/workflow/load.rb

@@ -0,0 +1,13 @@
+class Eco::CliDefault::Workflow
+  class Load < Eco::API::Common::Loaders::Workflow
+    require_relative 'load/input'
+    require_relative 'load/data'
+
+    [
+      Input,
+      Data
+    ].each do |wf_config|
+      wf_config.config_copy(to: self, all: true)
+    end
+  end
+end

data/lib/eco/cli_default/workflow/options.rb

@@ -0,0 +1,10 @@
+class Eco::CliDefault::Workflow
+  class Options < Eco::API::Common::Loaders::Workflow
+    config_block(:workflow, :options) do
+      on(:options) do
+        cli_usecases.cli_apply(io: io)
+        io.new(options: cli.config.options_set.process(io: io))
+      end
+    end
+  end
+end

data/lib/eco/cli_default/workflow/post_launch.rb

@@ -0,0 +1,65 @@
+class Eco::CliDefault::Workflow
+  class PostLaunch < Eco::API::Common::Loaders::Workflow
+    config_block(:workflow, :post_launch) do
+      before(:post_launch) do |wf_post|
+        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[: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:          data,
+          include_created: true
+        )
+        io.base.new(data: peo_aux)
+      end
+
+      with(: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 => err
+            raise unless err.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
+    end
+  end
+end

data/lib/eco/cli_default/workflow/report.rb

@@ -0,0 +1,17 @@
+class Eco::CliDefault::Workflow
+  class Report < Eco::API::Common::Loaders::Workflow
+    config_block(:workflow, :report) do
+      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(data: data.updated_or_created)
+          session.process_case('to-csv', io: aux_io, type: :export)
+        end
+      end
+    end
+  end
+end

data/lib/eco/cli_default/workflow/rescued_exception.rb

@@ -0,0 +1,21 @@
+class Eco::CliDefault::Workflow
+  class RescuedException < Eco::API::Common::Loaders::Workflow
+    config_block(:workflow, :exception) do
+      class << self
+        attr_accessor :rescued
+      end
+
+      # default rescue
+      exception do |err, io|
+        next io if rescued
+
+        self.rescued = true
+        log(:debug) { err.patch_full_message }
+
+        workflow.run(:close, io: io)
+      rescue StandardError => err
+        puts "Some problem in workflow.rescue: #{err}"
+      end
+    end
+  end
+end

data/lib/eco/cli_default/workflow/usecases.rb

@@ -0,0 +1,23 @@
+class Eco::CliDefault::Workflow
+  class Usecases < Eco::API::Common::Loaders::Workflow
+    config_block(:workflow, :usecases) do
+      before(:usecases) do
+        # save partial entries -> should be native to session.workflow
+        get_people     = options.dig(:people, :get)
+        partial_update = get_people && get_people[:type] == :partial
+
+        if !options[:dry_run] && partial_update
+          partial_file = session.config.people.partial_cache
+          session.file_manager.save_json(io.data, partial_file, :timestamp)
+        end
+      end
+
+      on(:usecases) do
+        next if cli_usecases.process(io: io)
+
+        log(:info) { 'No update operation specified... quitting' }
+        exit 0
+      end
+    end
+  end
+end