eco-helpers 3.0.26 → 3.0.28

data/lib/eco/api/usecases/base_io/validations.rb

@@ -12,6 +12,7 @@ class Eco::API::UseCases::BaseIO
         msg = "#{msg} of type '#{type}'" if type
         msg = "#{msg} (#{klass})"        if klass
         msg = "#{msg} requires an object '#{required}'. Given: #{given}."
+
         super(msg)
       end
 
@@ -28,7 +29,8 @@ class Eco::API::UseCases::BaseIO
     class << self
       def included(base)
         super
-        base.extend(ClassMethods)
+
+        base.extend ClassMethods
       end
     end
 
@@ -71,9 +73,9 @@ class Eco::API::UseCases::BaseIO
       elsif missing_data?
         raise MissingParameter.new(
           'UseCase',
-          type:      type,
-          required:  model,
-          given:     data.class,
+          type:     type,
+          required: model,
+          given:    data.class,
           usecase:  self
         )
       elsif !options.is_a?(Hash)

data/lib/eco/api/usecases/cli/option.rb

@@ -4,7 +4,9 @@ class Eco::API::UseCases::Cli
     attr_accessor :name, :desc, :callback
 
     def initialize(name, desc, &block)
-      @name, @desc, @callback = name, desc, block
+      @name     = name
+      @desc     = desc
+      @callback = block
     end
 
     def dup(name: self.name, desc: self.desc, &block)
@@ -12,7 +14,8 @@ class Eco::API::UseCases::Cli
     end
 
     def link_case(cli_config_case)
-      raise ArgumentError, "cli_config_case must have an 'add_option' method. Given: #{cli_config_case.class}" unless cli_config_case.respond_to?(:add_option)
+      msg = "cli_config_case must have an 'add_option' method. Given: #{cli_config_case.class}"
+      raise ArgumentError, msg unless cli_config_case.respond_to?(:add_option)
 
       cli_config_case.add_option(name, desc, &callback)
     end

data/lib/eco/api/usecases/default/people/amend/clear_abilities_case.rb

@@ -1,5 +1,5 @@
 class Eco::API::UseCases::Default::People::Amend::ClearAbilitiesTransCase < Eco::API::Common::Loaders::UseCase
-  name "clear-abilities"
+  name 'clear-abilities'
   type :transform
 
   def main(*_args)
@@ -9,7 +9,7 @@ class Eco::API::UseCases::Default::People::Amend::ClearAbilitiesTransCase < Eco:
   private
 
   def clear_abilities(users)
-    update = session.new_job("main", "clear-abilities", :update, usecase, :account)
+    update = session.new_job('main', 'clear-abilities', :update, usecase, :account)
     users.each do |person|
       person.account.permissions_custom = nil_abilities.dup
       update.add(person)

data/lib/eco/api/usecases/default/people/amend/restore_db_case.rb

@@ -1,7 +1,7 @@
 # @example
 #     -restore-db-from backup.json -skip-api-policies -skip-batch-policy -include-excluded -simulate
 class Eco::API::UseCases::Default::People::Amend::RestoreDBCase < Eco::API::Common::Loaders::UseCase
-  name "restore-db"
+  name 'restore-db'
   type :sync
 
   require_relative 'cli/restore_db_cli'
@@ -9,9 +9,9 @@ class Eco::API::UseCases::Default::People::Amend::RestoreDBCase < Eco::API::Comm
   def main(entries, people, session, options, usecase) # rubocop:disable Metrics/AbcSize
     require_people_as_entries!(entries)
 
-    restart  = session.new_job("main", "restart", :create, usecase) if options.dig(:include, :create)
-    update   = session.new_job("main", "update",  :update, usecase)
-    delete   = session.new_job("main", "delete",  :update, usecase)
+    restart  = session.new_job('main', 'restart', :create, usecase) if options.dig(:include, :create)
+    update   = session.new_job('main', 'update',  :update, usecase)
+    delete   = session.new_job('main', 'delete',  :update, usecase)
 
     if options.dig(:include, :delete)
       micro.with_each_leaver(entries, people, options) do |person|
@@ -43,13 +43,20 @@ class Eco::API::UseCases::Default::People::Amend::RestoreDBCase < Eco::API::Comm
 
   private
 
-  def core_copy(entry, person)
+  def core_copy(entry, person) # rubocop:disable Metrics/AbcSize
+    person.archived      = entry.archived      unless options.dig(:exclude, :archived)
     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
+
+    unless options.dig(:exclude, :contractor_organization_id)
+      person.contractor_organization_id =
+        entry.contractor_organization_id
+    end
+
+    person.freemium = entry.freemium
   end
 
   def account_copy(src, dst) # rubocop:disable Metrics/AbcSize
@@ -64,7 +71,7 @@ class Eco::API::UseCases::Default::People::Amend::RestoreDBCase < Eco::API::Comm
     end
 
     if src.preferences # rubocop:disable Style/IfUnlessModifier
-      dst.doc["preferences"] = JSON.parse((src.doc["preferences"] || {}).to_json)
+      dst.doc['preferences'] = JSON.parse((src.doc['preferences'] || {}).to_json)
     end
 
     unless options[:source_enviro]
@@ -92,8 +99,8 @@ class Eco::API::UseCases::Default::People::Amend::RestoreDBCase < Eco::API::Comm
     log(:error) {
       msg  = []
       msg << "There were #{re_starters.length} entries of the backup "
-      msg << "that do not exist in the (filtered?) people manager."
-      msg << "Some examples:"
+      msg << 'that do not exist in the (filtered?) people manager.'
+      msg << 'Some examples:'
       msg << "  * #{examples.join("\n  * ")}"
       msg.join("\n")
     }

data/lib/eco/api/usecases/default/people/treat/analyse_people_case.rb

@@ -1,5 +1,5 @@
 class Eco::API::UseCases::Default::People::Treat::Analyse < Eco::API::Common::Loaders::UseCase
-  name "analyse-people"
+  name 'analyse-people'
   type :export
 
   require_relative 'cli/analyse_people_cli'
@@ -12,7 +12,7 @@ class Eco::API::UseCases::Default::People::Treat::Analyse < Eco::API::Common::Lo
     elsif case_options[:identify_unnamed]
       identify_unnamed
     else
-      log(:info) { "No analysis operation was specified" }
+      log(:info) { 'No analysis operation was specified' }
     end.tap do |people_involved|
       next unless people_involved
 
@@ -27,7 +27,7 @@ class Eco::API::UseCases::Default::People::Treat::Analyse < Eco::API::Common::Lo
     similarity_analytics.unnamed.tap do |unnamed|
       next unless unnamed.empty?
 
-      log(:info) { "There were no people with no name!!" }
+      log(:info) { 'There were no people with no name!!' }
     end
   end
 
@@ -35,13 +35,13 @@ class Eco::API::UseCases::Default::People::Treat::Analyse < Eco::API::Common::Lo
     analysed = similarity_screening
 
     if case_options[:ignore_matching_words]
-      log(:info) { "Fine tune results by ignoring matching words..." }
+      log(:info) { 'Fine tune results by ignoring matching words...' }
       analysed = strict_similarity(analysed)
     end
 
     similarity_analytics.newSimilarity(analysed).tap do |related_people|
       if related_people.empty?
-        log(:info) { "There were no possible duplicates identified!!" }
+        log(:info) { 'There were no possible duplicates identified!!' }
       else
         report = similarity_analytics.report(analysed, format: :txt)
         save!(report)
@@ -157,23 +157,23 @@ class Eco::API::UseCases::Default::People::Treat::Analyse < Eco::API::Common::Lo
   end
 
   def output_file
-    @output_file ||= options.dig(:output, :file) || "analytics.txt"
+    @output_file ||= options.dig(:output, :file) || 'analytics.txt'
   end
 
   def save!(data)
-    ext = File.extname(output_file).downcase.delete(".")
+    ext = File.extname(output_file).downcase.delete('.')
 
     log(:info) { "Generating file '#{output_file}'" }
 
-    File.open(output_file, "w") do |fd|
+    File.open(output_file, 'w') do |fd|
       case ext
-      when "txt"
+      when 'txt'
         fd << data
-      when "html"
-        puts "html is still not supported"
+      when 'html'
+        puts 'html is still not supported'
         exit(1)
-      when "json"
-        puts "json is still not supported"
+      when 'json'
+        puts 'json is still not supported'
         exit(1)
       end
     end
@@ -182,11 +182,11 @@ class Eco::API::UseCases::Default::People::Treat::Analyse < Eco::API::Common::Lo
   # A way to use command line to specify part
   # => i.e. details[first-name] AND details[surname]
   def proc_value_access(expression)
-    #return expression.to_sym if expression.start_with?(":")
-    subexpressions = expression.split(" AND ")
+    #return expression.to_sym if expression.start_with?(':')
+    subexpressions = expression.split(' AND ')
     proc do |person|
       values = subexpressions.map {|exp| attribute_access(person, exp)}
-      values.compact.join(" ")
+      values.compact.join(' ')
     end
   end
 
@@ -216,9 +216,9 @@ class Eco::API::UseCases::Default::People::Treat::Analyse < Eco::API::Common::Lo
 
     is_method = part.is_a?(Symbol) || obj.respond_to?(part.to_sym)
     return obj.send(part.to_sym)    if is_method
-    return get_attr(obj, part[1..]) if part.start_with?(":")
+    return get_attr(obj, part[1..]) if part.start_with?(':')
 
-    if part.start_with?("details[")
+    if part.start_with?('details[')
       via_details = obj.respond_to?(:details) && (details = obj.details)
       return unless via_details
 
@@ -228,11 +228,11 @@ class Eco::API::UseCases::Default::People::Treat::Analyse < Eco::API::Common::Lo
       raise "Review your -use-field expression. It should read: person.details[target-alt_id]"
     end
 
-    if part.start_with?("account")
+    if part.start_with?('account')
       return obj.respond_to?(:account) ? obj.account : nil
     end
 
-    return obj if part.start_with?("person")
+    return obj if part.start_with?('person')
 
     raise "Review your expression. Cannot recognize '#{part}' as part of '#{obj.class}'"
   end

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

@@ -2,11 +2,11 @@ module Eco
   module API
     class UseCases
       class Default < Eco::API::UseCases
-        # autoloads_children_of "Eco::API::Common::Loaders::UseCase"
-        # autoload_namespace    "Eco::API::UseCases::Default"
-        # autoload_namespace    "Eco::API::UseCases::DefaultCases"
-        # autoload_namespace    "Eco::API::UseCases::OozeCases"
-        # autoload_namespace    "Eco::API::UseCases::GraphQL::Cases"
+        # autoloads_children_of 'Eco::API::Common::Loaders::UseCase'
+        # autoload_namespace    'Eco::API::UseCases::Default'
+        # autoload_namespace    'Eco::API::UseCases::DefaultCases'
+        # autoload_namespace    'Eco::API::UseCases::OozeCases'
+        # autoload_namespace    'Eco::API::UseCases::GraphQL::Cases'
       end
     end
   end

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

@@ -1,5 +1,5 @@
 class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::UseCase
-  name "to-csv"
+  name 'to-csv'
   type :export
 
   OUT_FILENAME = 'pm'.freeze
@@ -8,14 +8,14 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
     options[:end_get] = false
 
     unless people && !people.empty?
-      log(:warn) { "No source people to create the file... aborting!" }
+      log(:warn) { 'No source people to create the file... aborting!' }
       return false
     end
 
     if options.dig(:export, :options, :split_schemas)
       by_schema.each do |id, people|
         sch_name = schemas.to_name(id)
-        prefix   = sch_name ? sch_name.gsub(" ", "_").downcase : "no_schema"
+        prefix   = sch_name ? sch_name.gsub(' ', '_').downcase : 'no_schema'
         filename = in_folder("#{prefix}_#{File.basename(file)}")
         create_file!(filename, people)
       end
@@ -29,7 +29,7 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
   def create_file!(filename = file, data = people)
     session.log(:info) { "going to create file: #{filename}" }
 
-    CSV.open(filename, "w") do |csv|
+    CSV.open(filename, 'w') do |csv|
       csv << spot_header(data.first)
       data.each do |person|
         csv << to_row(person)
@@ -40,13 +40,13 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
   def to_row(person)
     entry = to_entry_type(person)
     entry.values_at(*keys(entry)).tap do |row|
-      row << (schemas.to_name(person.details&.schema_id) || "No Schema")
+      row << (schemas.to_name(person.details&.schema_id) || 'No Schema')
     end
   end
 
   def spot_header(person = people.first)
     header = keys(to_entry_type(person))
-    header << "Schema"
+    header << 'Schema'
     header = yield(header) if block_given?
     header = nice_header_names(header, schema: schema(person.details)) if nice_header_names?
     header
@@ -73,14 +73,14 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
   end
 
   def deps
-    @deps ||= {"supervisor_id" => {people: people}}
+    @deps ||= {'supervisor_id' => {people: people}}
   end
 
   def file
     @file ||= out_filename.tap do |filename|
       next if filename
 
-      log(:error) { "Destination file not specified" }
+      log(:error) { 'Destination file not specified' }
       return false
     end
   end

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

@@ -1,12 +1,12 @@
 class Eco::API::UseCases::DefaultCases::UpsertCase < Eco::API::Common::Loaders::UseCase
-  name "upsert"
+  name 'upsert'
   type :sync
 
   def main(entries, people, session, options, usecase)
     micro    = session.micro
-    creation = session.new_job("main", "create", :create, usecase)
-    update   = session.new_job("main", "update", :update, usecase)
-    supers   = session.new_job("post", "supers", :update, usecase, :core)
+    creation = session.new_job('main', 'create', :create, usecase)
+    update   = session.new_job('main', 'update', :update, usecase)
+    supers   = session.new_job('post', 'supers', :update, usecase, :core)
 
     micro.with_each(entries, people, options, append_created: append_created) do |entry, person|
       person.new? ? creation.add(person) : update.add(person)

data/lib/eco/api/usecases/graphql/helpers/base.rb

@@ -11,7 +11,7 @@ module Eco::API::UseCases::GraphQL::Helpers
 
     # Keep a copy of the requests/responses for future reference
     def backup(data, type:)
-      dry_run   = simulate? ? "_dry_run" : ""
+      dry_run   = simulate? ? '_dry_run' : ''
       dir       = config.people.requests_folder
       file      = File.join(dir, "#{type}#{dry_run}.json")
       session.file_manager.save_json(data, file, :timestamp)

data/lib/eco/api/usecases/graphql/helpers/location/base/tree_tracking.rb

@@ -35,7 +35,11 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
 
         latest_tree = tree if tree.is_a?(Eco::API::Organization::TagTree)
         if tree.respond_to?(:treeify) && track_current_tree?
-          latest_tree ||= Eco::API::Organization::TagTree.new(tree.treeify, id: tree.id, name: tree.name)
+          latest_tree ||= Eco::API::Organization::TagTree.new(
+            tree.treeify,
+            id:   tree.id,
+            name: tree.name
+          )
         end
 
         latest_tree.tap do

data/lib/eco/api/usecases/graphql/helpers/location/command/diffs/stages/commandable.rb

@@ -4,8 +4,9 @@ class Eco::API::UseCases::GraphQL::Helpers::Location::Command::Diffs
       class << self
         def included(base)
           super
-          base.extend(ClassMethods)
-          base.send(:include, DiffSortable)
+
+          base.extend ClassMethods
+          base.send :include, DiffSortable
         end
       end
 
@@ -37,7 +38,8 @@ class Eco::API::UseCases::GraphQL::Helpers::Location::Command::Diffs
       end
 
       def stage_diffs(stage)
-        raise "There is NO support for stage '#{stage}'. Please review" unless respond_to?(stage)
+        msg = "There is NO support for stage '#{stage}'. Please review"
+        raise ArgumentError, msg unless respond_to?(stage)
 
         sort_diffs(stage) do
           send(stage)

data/lib/eco/api/usecases/graphql/helpers/location/command/result.rb

@@ -60,13 +60,13 @@ module Eco::API::UseCases::GraphQL::Helpers::Location::Command
     def command_id
       return unless result
 
-      command_result["id"]
+      command_result['id']
     end
 
     def as_json
       {
-        "request"  => input,
-        "response" => result.doc
+        'request'  => input,
+        'response' => result.doc
       }
     end
   end

data/lib/eco/api/usecases/graphql/helpers/location/command.rb

@@ -72,13 +72,16 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
       pages = (total.to_f / size).ceil.to_i
       page  = 1
       out   = []
+
       comms.each_slice(size) do |comms_slice|
         sliced_input = input_data.slice(:clientMutationId, :id).merge(commands: comms_slice)
+
         yield(sliced_input, page, pages, comms_slice.count, total).tap do |response|
           out.push([sliced_input, response])
           page += 1
         end
       end
+
       out
     end
   end

data/lib/eco/api/usecases/graphql/samples/location/command/dsl.rb

@@ -17,8 +17,8 @@ class Eco::API::UseCases::GraphQL::Samples::Location
     #       end
     #     end
     def inputs(*_args, force_continue: force_continue?, **_kargs, &_block) # rubocop:disable Lint/UnusedMethodArgument
-      msg  = "You should implement this method in your child class.\n"
-      msg << "Which should yield the input Hash and the stage or descriptor."
+      msg  = "You should implement this method in your child class.\n'
+      msg << 'Which should yield the input Hash and the stage or descriptor."
       raise Eco::API::UseCases::GraphQL::Base::NotImplementedMethod, msg
     end
 

data/lib/eco/api/usecases/graphql/samples/location/command/service/tree_update.rb

@@ -8,6 +8,7 @@ class Eco::API::UseCases::GraphQL::Samples::Location
       class << self
         def included(base)
           super
+
           base.send :include, Eco::API::UseCases::GraphQL::Samples::Location::Service::TreeDiff
           base.send :include, Eco::API::UseCases::GraphQL::Samples::Location::Command::DSL
           base.send :include, Eco::API::UseCases::GraphQL::Utils::Sftp
@@ -40,7 +41,11 @@ class Eco::API::UseCases::GraphQL::Samples::Location
             original_tree: current_tree,
             logger:        logger
           ).tap do |nodes_diff|
-            archive_input = input(nodes_diff.stage_commands(:archive), force_continue: true)
+            archive_input = input(
+              nodes_diff.stage_commands(:archive),
+              force_continue: true
+            )
+
             sliced_batches(
               archive_input,
               desc:            stage,
@@ -48,6 +53,7 @@ class Eco::API::UseCases::GraphQL::Samples::Location
             ) do |sliced_input, response, page, pages, count, total| # rubocop:disable Metrics/ParameterLists
               page_results = request_results_class.new(sliced_input, response)
               (results[stage] ||= []) << page_results
+
               self.error ||= page_errors?(page_results, page, pages, count, total, stage: stage)
             end
           end
@@ -89,8 +95,8 @@ class Eco::API::UseCases::GraphQL::Samples::Location
           return if options.dig(:workflow, :no_email)
 
           digest_msgs   = logger.cache.logs(level: %i[info error warn])
-          str_exception = exception ? " - Exception!" : ''
-          str_exception = " - Aborted!" if exiting?
+          str_exception = exception ? ' - Exception!' : ''
+          str_exception = ' - Aborted!' if exiting?
 
           subject       = "#{config.active_enviro} - #{title}#{str_exception}"
 

data/lib/eco/api/usecases/graphql/samples/location/service/tree_diff/convertible/inputable.rb

@@ -4,14 +4,15 @@ module Eco::API::UseCases::GraphQL::Samples::Location::Service
       module Inputable
         class << self
           def included(base)
-            super(base)
+            super
+
             base.send :include, Eco::Data::Files
           end
         end
 
         include Eco::API::UseCases::GraphQL::Helpers::Base::CaseEnv
 
-        IN_FILENAME  = /requested_tree\.csv/.freeze
+        IN_FILENAME  = /requested_tree\.csv/
         IN_FOLDER    = 'sftp'.freeze
 
         private
@@ -25,7 +26,7 @@ module Eco::API::UseCases::GraphQL::Samples::Location::Service
             if file
               log(:info) { "Using input file '#{file}'" }
             else
-              log(:warn) { "Could not find any input file" }
+              log(:warn) { 'Could not find any input file' }
               exit(1)
             end
           end
@@ -45,7 +46,7 @@ module Eco::API::UseCases::GraphQL::Samples::Location::Service
         end
 
         def input_folder
-          "#{config.active_enviro}/#{self.class::IN_FOLDER}"
+          File.join(config.active_enviro, self.class::IN_FOLDER)
         end
       end
     end

data/lib/eco/api/usecases/graphql/samples/location/service/tree_diff/convertible/parsing.rb

@@ -26,18 +26,21 @@ module Eco::API::UseCases::GraphQL::Samples::Location::Service
             row_transform&.call(row)
             transform_classifications(row)
           end
+
           csv
         end
 
         # The user define block for row transformation
         def custom_input_row_transform_block
-          return nil unless respond_to?(:custom_input_row_transform, true)
+          return unless respond_to?(:custom_input_row_transform, true)
+
           method(:custom_input_row_transform)
         end
 
         # The user define block for row transformation
         def custom_input_csv_transform_block
-          return nil unless respond_to?(:custom_input_csv_transform, true)
+          return unless respond_to?(:custom_input_csv_transform, true)
+
           method(:custom_input_csv_transform)
         end
       end

data/lib/eco/api/usecases/graphql/samples/location/service/tree_diff.rb

@@ -5,11 +5,11 @@ module Eco::API::UseCases::GraphQL::Samples
     #    class Custom::UseCase::TagtreeDiff < Eco::API::UseCases::GraphQL::Samples::Location
     #      name 'tagtree-diff'
     #      type :other
-
+    #
     #      require_relative 'cli/10_tagtree_diff_cli'
-
+    #
     #      include Eco::API::UseCases::GraphQL::Samples::Location::Service::TreeDiff
-
+    #
     #      IN_FILENAME  = /requested_tree\.csv/.freeze
     #      IN_FOLDER    = 'sftp'.freeze
     #      HEADER_MAPS  = {

data/lib/eco/api/usecases/graphql/utils/sftp.rb

@@ -1,6 +1,6 @@
 module Eco::API::UseCases::GraphQL::Utils
   module Sftp
     include Eco::API::UseCases::GraphQL::Helpers::Base::CaseEnv
-    include Eco::API::UseCases::Lib::Sftp
+    include Eco::API::UseCases::Lib::Files::Sftp
   end
 end

data/lib/eco/api/usecases/lib/{file_pattern.rb → files/file_pattern.rb}

@@ -1,4 +1,4 @@
-module Eco::API::UseCases::Lib
+module Eco::API::UseCases::Lib::Files
   module FilePattern
     class WrongConst < ArgumentError; end