eco-helpers 3.0.17 → 3.0.19

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

@@ -0,0 +1,71 @@
+class Eco::API::UseCases::Default::Utils::JsonToCsv < Eco::API::Common::Loaders::UseCase
+  require_relative 'cli/json_to_csv_cli'
+
+  name 'json-to-csv'
+  type :other
+
+  def main(*_args)
+    return if simulate?
+
+    CSV.open(out_filename, 'w') do |csv|
+      csv << all_keys
+      data.each do |item|
+        csv << item.values_at(*all_keys)
+      end
+    ensure
+      log(:info) {
+        "Generated output file: '#{File.expand_path(out_filename)}'."
+      }
+    end
+  end
+
+  private
+
+  def all_keys
+    @all_keys ||= data.each_with_object([]) do |item, head|
+      head.concat(item.keys - head)
+    end
+  end
+
+  def data
+    @data ||= parse_json_file.tap do |dt|
+      ensure_array!(dt)
+
+      log(:info) {
+        "Loaded #{dt.count} items (from file '#{File.basename(input_file)}')"
+      }
+
+      exit 0 if simulate?
+    end
+  end
+
+  def out_filename
+    @out_filename ||= ''.then do
+      input_basename = File.basename(input_file)
+      base_name      = File.basename(input_basename, '.json')
+      "#{base_name}.csv"
+    end
+  end
+
+  def input_file
+    options.dig(:source, :file)
+  end
+
+  def ensure_array!(data)
+    return if data.is_a?(Array)
+
+    msg = "Expecting JSON file to contain an Array. Given: #{data.class}"
+    log(:error) { msg }
+    raise msg
+  end
+
+  def parse_json_file(filename = input_file)
+    fd = File.open(filename)
+    JSON.load fd # rubocop:disable Security/JSONLoad
+  rescue JSON::ParserError => err
+    log(:error) { "Parsing error on file '#{filename}'" }
+    raise err
+  ensure
+    fd&.close
+  end
+end

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

@@ -0,0 +1,127 @@
+class Eco::API::UseCases::Default::Utils::SortCsv < Eco::API::Custom::UseCase
+  name 'sort-csv'
+  type :other
+
+  require_relative 'cli/sort_csv_cli'
+
+  def main(*_args)
+    if simulate?
+      count = Eco::CSV.count(input_file)
+      log(:info) { "CSV '#{input_file}' has #{count} rows." }
+    else
+      group_input_rows
+      generate_file
+    end
+  end
+
+  private
+
+  attr_reader :headers, :headers_rest
+
+  def group_input_rows
+    idx   = 0
+    first = true
+
+    Eco::CSV.foreach(input_file, headers: true, skip_blanks: true) do |row|
+      idx += 1
+
+      if first
+        first           = false
+        @output_headers = row.headers
+        require_sort_field!(row, file: input_file)
+      end
+
+      pivot_value = row[sort_field]
+      (row_groups[pivot_value] ||= []) << row
+
+      if (idx % 500).zero?
+        print "... Tracked #{idx} rows          \r"
+        $stdout.flush
+      end
+    end
+  ensure
+    log(:info) { "Tracked #{idx} rows"}
+  end
+
+  def generate_file
+    idx = 0
+
+    CSV.open(output_filename, 'wb') do |csv|
+      csv << @output_headers
+
+      row_groups.keys.sort.each do |key|
+        row_groups[key].each do |row|
+          csv << row.values_at(*@output_headers)
+
+          idx += 1
+          if (idx % 500).zero?
+            print "... Sorted #{idx} rows          \r"
+            $stdout.flush
+          end
+        end
+      end
+    end
+  ensure
+    msg = "Generated file '#{output_filename}' with #{idx} rows."
+    log(:info) { msg } unless simulate?
+  end
+
+  def row_groups
+    @row_groups ||= {}
+  end
+
+  def output_filename
+    return nil unless input_name
+
+    File.join(input_dir, "#{input_name}_sorted#{input_ext}")
+  end
+
+  def input_name
+    @input_name ||= File.basename(input_basename, input_ext)
+  end
+
+  def input_ext
+    @input_ext ||= input_basename.split('.')[1..].join('.').then do |name|
+      ".#{name}"
+    end
+  end
+
+  def input_basename
+    @input_basename ||= File.basename(input_full_filename)
+  end
+
+  def input_dir
+    @input_dir = File.dirname(input_full_filename)
+  end
+
+  def input_full_filename
+    @input_full_filename ||= File.expand_path(input_file)
+  end
+
+  def input_file
+    options.dig(:input, :file)
+  end
+
+  def require_sort_field!(row, file:)
+    return true if row.key?(sort_field)
+
+    msg = "Sort field '#{sort_field}' missing in header of file '#{file}'"
+    log(:error) { msg }
+    raise msg
+  end
+
+  def sort_field
+    @sort_field ||= opts_sort_by.tap do |pivot|
+      next if pivot
+
+      msg = "The pivot field should be specified with -by option"
+
+      log(:error) { msg }
+      raise msg
+    end
+  end
+
+  def opts_sort_by
+    options.dig(:input, :sort_by)
+  end
+end

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

@@ -0,0 +1,224 @@
+class Eco::API::UseCases::Default::Utils::SplitJson < Eco::API::Common::Loaders::UseCase
+  require_relative 'cli/split_json_cli'
+
+  MAX_ITEMS = 15_000
+
+  name "split-json"
+  type :other
+
+  def main(*_args)
+    if simulate?
+      count = input_json.count
+      log(:info) { "JSON '#{input_file}' has #{count} elements." }
+    else
+      split_json_into_files!
+
+      msg  = []
+      msg << "Total elements: #{total_count}"
+      msg << "Generated files:"
+      out_files.each do |file|
+        msg << "  * #{file}'"
+      end
+
+      log(:info) { msg.join("\n") }
+    end
+  end
+
+  private
+
+  def split_json_into_files!
+    first = true
+
+    while pending?
+      swap_file! if first
+      first = false
+
+      curr_json << input_json.shift
+      next_count!
+
+      swap_file! if split?
+    end
+
+    generate_file!
+  end
+
+  def split?
+    return false unless curr_count > max_items
+
+    true
+  end
+
+  def max_items
+    @max_items ||= max_items_options || self.class::MAX_ITEMS
+  end
+
+
+  # OPTIONS
+
+  def max_items_options
+    return unless (num = options.dig(:output, :file, :max_items))
+
+    num = num.to_i
+    num = nil if num.zero?
+    num
+  end
+
+  # OUTPUT JSON
+
+  # Returns the last json array and blanks the variable
+  def exporting_json!
+    curr_json.tap do
+      @curr_json = []
+    end
+  end
+
+  def curr_json
+    @curr_json ||= []
+  end
+
+  def pending?
+    !input_json.empty?
+  end
+
+  def input_json
+    @json ||= JSON.load(File.open(input_file, 'r'))
+  end
+
+  # COUNTS
+
+  def next_count!
+    @curr_count  = curr_count + 1
+    @total_count = total_count + 1
+  end
+
+  def total_count
+    @total_count ||= 0
+  end
+
+  def curr_count
+    @curr_count ||= 0
+  end
+
+  def new_count!
+    @curr_count = 0
+  end
+
+  # FILE GENERATION
+
+  def swap_file!
+    generate_file!
+    next_file!
+  end
+
+  def generate_file!
+    return unless @curr_file
+
+    if curr_json.empty?
+      log(:info) {
+        msg  = "No pending elements to be transferred "
+        msg << "(skipping creation of file '#{curr_file}')"
+        msg
+      }
+      out_files -= [curr_file]
+      return
+    end
+
+    log(:info) {
+      msg  = "Generating file at elem #{total_count} "
+      msg << "(file elements: #{curr_count})"
+      msg
+    }
+
+    save_json(exporting_json!, curr_file)
+    new_count!
+  end
+
+  def save_json(data, file)
+    File.open(file, 'w') do |fd|
+      first = true
+
+      fd << '['
+      data.each do |elem|
+        fd << "," unless first
+        first = false
+
+        fd << elem.to_json
+      end
+      fd << ']'
+    end.tap do
+      log(:info) {
+        "Generated file '#{file}'"
+      }
+    end
+  end
+
+  # OUTPUT FILES
+  attr_reader :curr_file
+
+  def file_count
+    @file_count ||= 0
+  end
+
+  def next_file!
+    @file_count = file_count + 1
+    @curr_file  = generate_name(@file_count)
+    @curr_file.tap do
+      out_files << @curr_file
+    end
+  end
+
+  def out_files
+    @out_files ||= []
+  end
+
+  def generate_name(fidx)
+    File.join(input_dir, "#{input_name}_#{file_number(fidx)}#{input_ext}")
+  end
+
+  def file_number(num)
+    "#{zeroed}#{num}"[-5..]
+  end
+
+  def zeroed
+    "0" * 5
+  end
+
+  # INPUT FILE
+
+  def input_name
+    @input_name ||= File.basename(input_basename, input_ext)
+  end
+
+  def input_ext
+    @input_ext ||= input_basename.split('.')[1..].join('.').then do |name|
+      ".#{name}"
+    end
+  end
+
+  def input_basename
+    @input_basename ||= File.basename(input_full_filename)
+  end
+
+  def input_dir
+    @input_dir = File.dirname(input_full_filename)
+  end
+
+  def input_full_filename
+    @input_full_filename ||= File.expand_path(input_file)
+  end
+
+  def input_file
+    options.dig(:source, :file).tap do |file|
+      next if file && File.exist?(file)
+
+      unless file
+        log(:warn) { 'No input file provided' }
+        exit 1
+      end
+
+      log(:warn) {
+        "File '#{file}' doesn't exist"
+      }
+    end
+  end
+end

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

@@ -10,3 +10,7 @@ module Eco
 end
 
 require_relative 'utils/split_csv_case'
+require_relative 'utils/split_json_case'
+require_relative 'utils/json_to_csv_case'
+require_relative 'utils/sort_csv_case'
+require_relative 'utils/group_csv_case'

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.0.17'.freeze
+  VERSION = '3.0.19'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.0.17
+  version: 3.0.19
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-17 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -229,7 +229,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.5
+        version: 0.10.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -239,7 +239,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.5
+        version: 0.10.7
 - !ruby/object:Gem::Dependency
   name: ecoportal-api-graphql
   requirement: !ruby/object:Gem::Requirement
@@ -249,7 +249,7 @@ dependencies:
         version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -259,7 +259,7 @@ dependencies:
         version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.3
 - !ruby/object:Gem::Dependency
   name: ecoportal-api-v2
   requirement: !ruby/object:Gem::Requirement
@@ -269,7 +269,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.0.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -279,7 +279,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.0.12
 - !ruby/object:Gem::Dependency
   name: ed25519
   requirement: !ruby/object:Gem::Requirement
@@ -551,6 +551,10 @@ 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/helpers.rb
+- lib/eco/api/common/people/default_parsers/helpers/expected_headers.rb
+- lib/eco/api/common/people/default_parsers/helpers/null_parsing.rb
+- lib/eco/api/common/people/default_parsers/json_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
@@ -658,10 +662,9 @@ files:
 - lib/eco/api/session/batch/jobs_groups.rb
 - lib/eco/api/session/batch/launcher.rb
 - lib/eco/api/session/batch/launcher/benchmarking.rb
-- lib/eco/api/session/batch/launcher/mode.rb
+- lib/eco/api/session/batch/launcher/mode_size.rb
 - lib/eco/api/session/batch/launcher/options.rb
 - lib/eco/api/session/batch/launcher/retry.rb
-- lib/eco/api/session/batch/launcher/size.rb
 - lib/eco/api/session/batch/launcher/status_handling.rb
 - lib/eco/api/session/batch/launcher/valid_methods.rb
 - lib/eco/api/session/batch/policies.rb
@@ -736,8 +739,16 @@ files:
 - lib/eco/api/usecases/default/people/utils/switch_supervisor_case.rb
 - lib/eco/api/usecases/default/people/utils/transfer_account_case.rb
 - lib/eco/api/usecases/default/utils.rb
+- lib/eco/api/usecases/default/utils/cli/group_csv_cli.rb
+- lib/eco/api/usecases/default/utils/cli/json_to_csv_cli.rb
+- lib/eco/api/usecases/default/utils/cli/sort_csv_cli.rb
 - lib/eco/api/usecases/default/utils/cli/split_csv_cli.rb
+- lib/eco/api/usecases/default/utils/cli/split_json_cli.rb
+- lib/eco/api/usecases/default/utils/group_csv_case.rb
+- lib/eco/api/usecases/default/utils/json_to_csv_case.rb
+- lib/eco/api/usecases/default/utils/sort_csv_case.rb
 - lib/eco/api/usecases/default/utils/split_csv_case.rb
+- lib/eco/api/usecases/default/utils/split_json_case.rb
 - lib/eco/api/usecases/default_cases.rb
 - lib/eco/api/usecases/default_cases/create_case.rb
 - lib/eco/api/usecases/default_cases/delete_sync_case.rb
@@ -952,7 +963,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: eco-helpers to manage people api cases

data/lib/eco/api/session/batch/launcher/mode.rb

@@ -1,23 +0,0 @@
-module Eco
-  module API
-    class Session
-      class Batch
-        module Launcher
-          module Mode
-            include Eco::API::Session::Batch::Launcher::Options
-
-            # @return [Symbol] the batch mode to run
-            def batch_mode(opts = options)
-              opts.dig(:workflow, :batch, :mode) || :batch
-            end
-
-            # @return [Boolean] are we running in `:job` mode?
-            def job_mode?(opts = options)
-              batch_mode(opts) == :job
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/eco/api/session/batch/launcher/size.rb

@@ -1,40 +0,0 @@
-module Eco
-  module API
-    class Session
-      class Batch
-        module Launcher
-          module Size
-            include Eco::API::Session::Batch::Launcher::Mode
-
-            DEFAULT_BATCH_SIZE = 50
-            DEFAULT_JOB_SIZE   = 100
-
-            def batch_size(opts = options)
-              return job_mode_size if job_mode?(opts)
-
-              batch_mode_size
-            end
-
-            private
-
-            def job_mode_size
-              options.dig(:workflow, :batch, :job, :size).then do |size|
-                next self.class::DEFAULT_JOB_SIZE unless size
-
-                size
-              end
-            end
-
-            def batch_mode_size
-              options.dig(:workflow, :batch, :size).then do |size|
-                next self.class::DEFAULT_BATCH_SIZE unless size
-
-                [size, 100].min
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end