eco-helpers 3.0.37 → 3.1.2

data/lib/eco/api/usecases/ooze_samples/target_oozes_update_case.rb

@@ -2,7 +2,7 @@
 # @note
 #   - `target_ids` => Expects options[:source][:file] where at least the 1st column should be the target entry `ids`
 class Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase < Eco::API::UseCases::OozeSamples::RegisterUpdateCase
-  name "target-oozes-update-case"
+  name 'target-oozes-update-case'
   type :other
 
   private
@@ -24,12 +24,15 @@ class Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase < Eco::API::UseCase
           log(:warn) { "Could not get page #{id}" }
         end
       end
+
       update_oozes
     end
   end
 
   def batched_target_ids
-    raise "Missing block. It yields in slices of #{self.class.batch_size} ids" unless block_given?
+    msg = "Missing block. It yields in slices of #{self.class.batch_size} ids"
+    raise ArgumentError, msg unless block_given?
+
     target_ids_preview
     pool = []
     target_ids.each do |id|
@@ -47,20 +50,20 @@ class Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase < Eco::API::UseCase
     @total_search_oozes  = target_ids.count
     @dupped_search_oozes = dups.count
 
-    dups_str = dups.count.positive? ? "There are #{dups.count} duplicated ids" : "No duplicates detected"
+    dups_str = dups.count.positive? ? "There are #{dups.count} duplicated ids" : 'No duplicates detected'
     msg = "Total target entries: #{target_ids.count} (#{dups_str})"
 
-    default_answer = session.config.run_mode_remote?? "Y" : "N"
+    default_answer = session.config.run_mode_remote?? 'Y' : 'N'
 
     session.prompt_user(
-      "Do you want to proceed (y/N):",
+      'Do you want to proceed (y/N):',
       explanation: msg,
       default:     default_answer,
       timeout:     10
     ) do |res|
-      unless res.upcase.start_with?("Y")
-        puts "..."
-        log(:info) { "Aborting script..." }
+      unless res.upcase.start_with?('Y')
+        puts '...'
+        log(:info) { 'Aborting script...' }
         exit(0)
       end
     end

data/lib/eco/api/usecases/samples/drivers/sftp_sample.rb

@@ -57,6 +57,8 @@ class Eco::API::UseCases::Samples::Drivers::Sftp < Eco::API::Common::Loaders::Us
     end
   end
 
+  # @todo when `sftp_move_file` fails, it still `puts` the message
+  #   that it moved the file(s) to the `archive_subfolder`
   def archive_files
     with_remote_files(pattern: file_pattern) do |file|
       source = to_remote_path(file.name) # should probably be file.longname

data/lib/eco/api/usecases/samples/drivers/url_pull_sample.rb

@@ -62,7 +62,12 @@ class Eco::API::UseCases::Samples::Drivers::UrlPull < Eco::API::Common::Loaders:
   end
 
   def http_start(uri, &block)
-    Net::HTTP.start(uri.hostname, uri.port, request_options(uri), &block)
+    Net::HTTP.start(
+      uri.hostname,
+      uri.port,
+      request_options(uri),
+      &block
+    )
   end
 
   def base_request(uri, user: nil, pass: '')
@@ -95,7 +100,8 @@ class Eco::API::UseCases::Samples::Drivers::UrlPull < Eco::API::Common::Loaders:
 
   def target_url_const
     if (fpc = options.dig(:url_pull, :target_url_const))
-      raise WrongConst, "(#{self.class}) Invalid file pattern const referral: #{fpc}" unless fpc.match(CONST_REFERRAL)
+      msg = "(#{self.class}) Invalid file pattern const referral: #{fpc}"
+      raise WrongConst, msg unless fpc.match(CONST_REFERRAL)
 
       begin
         self.eval(fpc)

data/lib/eco/api/usecases/service/sftp/with_target_config.rb

@@ -36,39 +36,6 @@ module Eco::API::UseCases::Service
           self.class::ENV_PATHS if self.class.const_defined?(:ENV_PATHS)
         end
       end
-
-      # module ClassMethods
-      #   def wrap_with_target_sftp(*mtds)
-      #     mtds.map(&:to_sym).each do |method_name|
-      #       msg = "#{self} does not have instance method '#{method_name}'"
-      #       has_method = instance_method?(name: method_name, include_private: true, inherited: true)
-      #       raise ArgumentError, msg unless has_method
-      #
-      #       method_was_inherited = instance_inherited_method?(name: method_name)
-      #       method_is_public     = instance_method?(name: method_name, include_private: false)
-      #       original_method      = :"method_to_wrap_with_target_sftp_#{method_name}"
-      #
-      #       # don't over-override
-      #       next if instance_method?(name: original_method, include_private: true, inherited: true)
-      #
-      #       method_def = proc do |*args, **kargs, &block|
-      #         with_target_sftp_config do
-      #           if method_was_inherited
-      #             super(*args, **kargs, &block)
-      #           else
-      #             send(original_method, *args, **kargs, &block)
-      #           end
-      #         end
-      #       end
-      #
-      #       alias_method(original_method, method_name) unless method_was_inherited
-      #       define_method(method_name, &method_def)
-      #       private method_name unless method_is_public
-      #     end
-      #
-      #     self
-      #   end
-      # end
     end
   end
 end

data/lib/eco/api/usecases/service/sftp.rb

@@ -1,9 +1,15 @@
 require_relative 'sftp/with_target_config'
 module Eco::API::UseCases::Service
   # Class that pulls configuration from the subject (i.e. `remote_folder`)
+  # @note It accepts modify the targt SFTP in subclasses by defining two constants:
+  #   - `BASE_PATH` (String)
+  #   - `ENV_PATHS` (Hash)
+  # @note it makes public all methods of the `Files::Sftp` module.
   class Sftp
+    include Eco::Language::Methods::AccessModifier
     include Eco::API::UseCases::Lib::Files::Sftp
-    public(*Eco::API::UseCases::Lib::Files::Sftp.private_instance_methods(inherited: false))
+
+    make_public_all from: Eco::API::UseCases::Lib::Files::Sftp, inherited: false
 
     include WithTargetConfig
 

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

@@ -26,7 +26,7 @@ module Eco
         end
 
         def source_object
-          return nil unless callback_from_loader?
+          return unless callback_from_loader?
 
           callback_self
         end
@@ -77,7 +77,7 @@ module Eco
         attr_reader :callback
 
         def callback_self
-          eval("self", callback.binding, __FILE__, __LINE__)
+          eval('self', callback.binding, __FILE__, __LINE__)
         end
 
         def callback_from_loader?
@@ -86,6 +86,7 @@ module Eco
 
         # Set the instance variables `@session` and `@options`
         # in the use case definition
+        # @todo check if this method shouldn't really just be part of `uio`
         # @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(uio) # rubocop:disable Naming/AccessorMethodName

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

@@ -0,0 +1,5 @@
+class Eco::API::UseCases
+  class Workflow < Eco::Language::Models::Workflow
+    INPUT_OUTPUT_CLASS = Eco::API::UseCases::BaseIO
+  end
+end

data/lib/eco/api/usecases.rb

@@ -19,7 +19,7 @@ module Eco
         end
       end
 
-      extend  Eco::API::Common::ClassAutoLoader
+      extend  Eco::Language::Klass::AutoLoader
       include Enumerable
 
       autoloads_children_of 'Eco::API::Common::Loaders::UseCase'
@@ -29,6 +29,7 @@ module Eco
         @usecases      = {}
         @cache_init    = false
         @cases_by_name = {}
+
         init_caches
       end
 
@@ -52,6 +53,7 @@ module Eco
 
       def defined?(name, type: nil)
         return to_h.key?(key(name, type)) if type
+
         name?(name)
       end
 
@@ -83,7 +85,8 @@ module Eco
         puts "Warning: overriding '#{type}' case #{name}" if self.defined?(name, type: type)
 
         to_h[key(name, type)] = usecase
-        @cache_init = false
+        @cache_init           = false
+
         usecase
       end
 
@@ -102,7 +105,9 @@ module Eco
         msg = "Expected a Eco::API::UseCases object. Given #{cases.class}"
         raise msg unless cases.is_a?(Eco::API::UseCases)
 
-        to_h.merge!(cases.to_h).transform_values do |usecase|
+        to_h.merge!(
+          cases.to_h
+        ).transform_values do |usecase|
           usecase.root = self
         end
 
@@ -126,6 +131,7 @@ module Eco
         elsif type
           raise UseCases::UnknownCase.new(case_name: name, type: type)
         end
+
         raise UseCases::UnknownCase.new(case_name: name, type: type) unless (cases = by_name[name])
         raise UseCases::AmbiguousCaseReference.new(case_name: name)  if cases.length > 1
 
@@ -148,10 +154,10 @@ module Eco
 
       def init_caches
         # first, make sure it loads pending `:custom_children` children to be loaded
-        re_init = self.class.autoload_children(self)
+        re_init = self.class.autoload_children!(self)
         return true if @cache_init && !re_init
 
-        @by_name = @usecases.values.group_by(&:name)
+        @by_name    = @usecases.values.group_by(&:name)
         @cache_init = true
       end
 
@@ -176,6 +182,7 @@ require_relative 'usecases/use_case_chain'
 require_relative 'usecases/base_io'
 require_relative 'usecases/use_case_io'
 require_relative 'usecases/cli'
+require_relative 'usecases/workflow'
 require_relative 'usecases/lib'
 require_relative 'usecases/service'
 require_relative 'usecases/graphql'

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

@@ -105,7 +105,7 @@ module Eco
           if required && !filename
             puts "You need to specify a file or folder '#{key} file_or_folder'"
             exit(1)
-          elsif should_exist && filename && !file_exists?(filename)
+          elsif should_exist && filename && !File.exist?(filename)
             puts "This file/folder doesn't exist '#{filename}'"
             exit(1)
           end
@@ -113,14 +113,6 @@ module Eco
           filename = File.expand_path(filename) if filename && should_exist
           filename
         end
-
-        private
-
-        def file_exists?(filename)
-          return false if filename.nil?
-
-          File.exist?(filename) || File.exist?(File.expand_path(filename))
-        end
       end
     end
   end

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,18 @@
+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
+
+      after(:options) do
+        next unless session.config.dry_run?
+
+        session.log(:general) {
+          'Running in dry-run mode (simulate).'
+        }
+      end
+    end
+  end
+end