eco-helpers 2.0.31 → 2.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd31d354667802423a4003fe347af67916015eaeac0d1682cbe511d7afc11b40
-  data.tar.gz: d0f9d23f2ad6db33861441d9f865a9e5925eec7a1e4042f7246bbded8f61ce6f
+  metadata.gz: b4d6a312dda42afc3e6ba2becccf69d42121024d9b81e2c37276719089521971
+  data.tar.gz: a3536e8fba79c1600135b4c4fd523a9c3a5262d605c39c751a3dc278d096b96e
 SHA512:
-  metadata.gz: fafda0f2b9f6866499df3a641598800ea5dd2c2536710a759bbd0d30a307f36da8cc1cb30056de965134aea509ce1700df152d233d322b41c590048569ecd23e
-  data.tar.gz: d2f953274727fa35d8474da766dabee715f21b4ae227be9e0b4f31363d58fdcc1b0e410d10976b3f8608e14335d5f42c97dccd6a3d2e55ea37fb4a945d02d091
+  metadata.gz: 8fcb26823bc3b6e3d35522c13d410094ea056269c14dea3b47bcaf16991ff36cde9537507a6a21c952aa15f590fb1f5b1fc594e55d08f04782a8e2802c695d0c
+  data.tar.gz: fb2768c6e345da3dec034e7793876ecf25ae1cff76a059d98a38d9328c57884efb2a2f0b449eb28aea686ba074e477875fd8ba30201773170935f1c766fd45ae

data/CHANGELOG.md

@@ -1,11 +1,58 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.31] - 2021-07-xx
+## [2.0.35] - 2021-08-30
 
 ### Added
+  - `Eco::API::UseCases::OozeSamples::OozeBaseCase`
+    - `#new_target` optional warning when switching `target`
+      - `block` that is called when switching target and there were unsaved changes
+    - `#dirty?` helper method to check if there are changes
+    - `#before_loading_new_target` hook to allow child classes to anticipate when the `target` is going to change
 
 ### Changed
+  - `Eco::API::UseCases::OozeSamples::Helpers::Shortcuts#object_reference` improved reference text
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase`
+    - added resilience when switching target (i.e. from one stage to another stage in same entry)
+    - added `batch_queue`
+
+### Fixed
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase`
+    - actual `batch_size` updates
+    - actual safe switch of target (i.e. against another stage of same ooze)
+
+## [2.0.34] - 2021-08-28
+
+### Added
+  - `Eco::API::UseCases::OozeSamples::OozeBaseCase` refactored ooze base case
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase` new case for full register update
+
+### Changed
+  - `Eco::API::UseCases::OozeSamples::OozeRunBaseCase` made child of `OozeBaseCase` and simplified to its essential
+  - `Eco::API::UseCases::OozeSamples::OozeUpdateCase` remove unnecessary code and helpers that are now inherited from `OoozeBaseCase`
+  - `Eco::API::UseCases::OozeSamples::OozeFromDocCase` remove unnecessary code
+
+
+## [2.0.33] - 2021-08-16
+
+### Added
+  - `Eco::API::UseCases::OozeSamples::OozeFromDocCase` use case to abstract form from doc
+  - `docx` dependency
+  - A couple more of helpers for the Ooze Cases: `#titleize` & `#normalize_string`
+
+### Changed
+  - `ecoporta-api-v2` **gem** (upgrade dependency)
+
+### Fixed
+  - `Eco::API::UseCases::OozeSamples::OozeUpdateCase`, helper `with_stage`
+
+## [2.0.32] - 2021-07-14
+
+### Fixed
+  - `Eco::API::UseCases::OozeSamples::OozeUpdateCase` prompting user, fixed typo
+  - `Eco::API::Session::Batch::Job`: `include-excluded` again... typo.
+
+## [2.0.31] - 2021-07-13
 
 ### Fixed
   - `Eco::API::Session::Batch::Job`: `include-excluded` was triggering a type error.

data/eco-helpers.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
 
   spec.add_dependency 'ecoportal-api', '>= 0.8.3', '< 0.9'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.7', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.12', '< 0.9'
   spec.add_dependency 'aws-sdk-s3',    '>= 1.83.0', '< 2'
   spec.add_dependency 'aws-sdk-ses',   '>= 1.36.0', '< 2'
   spec.add_dependency 'dotenv',        '>= 2.7.6', '< 2.8'
@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'jaro_winkler',  '>= 1.5.4', '< 1.6'
   spec.add_dependency 'roo',           '>= 2.8.3', '< 2.9'
   spec.add_dependency 'roo-xls',       '>= 1.2.0', '< 1.3'
+  spec.add_dependency 'docx',          '>= 0.6.2', '< 0.7'
 end

data/lib/eco/api/session/batch/job.rb

@@ -252,14 +252,14 @@ module Eco
           # - filter out excluded entries from the api update
           def api_included(full_queue)
             return full_queue if type == :create
-            return full_queue unless excluded = session.config.people.api_excluded
+            return full_queue unless excluded_callback = session.config.people.api_excluded
             excluded = options.dig(:include, :excluded)
             if excluded.is_a?(Hash) && excluded[:only]
-              full_queue.select {|entry| excluded.call(entry, session, options, self)}
+              full_queue.select {|entry| excluded_callback.call(entry, session, options, self)}
             elsif options.dig(:include, :excluded)
               full_queue
             else
-              full_queue.select {|entry| !excluded.call(entry, session, options, self)}
+              full_queue.select {|entry| !excluded_callback.call(entry, session, options, self)}
             end
           end
 

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

@@ -139,6 +139,7 @@ module Eco
             explanation = "Batch TimeOut. You have #{retries_left} retries left."
             prompt_user(" Do you want to retry (y/N)?", default: "Y", explanation: explanation, timeout: 10) do |response|
               if response.upcase.start_with?("Y")
+                puts "\nOkay... let's retry!"
                 offer_retry_on(error_type, retries_left - 1, &block)
               else
                 raise

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

@@ -3,7 +3,7 @@ class Eco::API::UseCases::DefaultCases::UpsertCase < Eco::API::Common::Loaders::
   type :sync
 
   attr_reader :options
-  
+
   def main(entries, people, session, options, usecase)
     @options = options
     micro    = session.micro

data/lib/eco/api/usecases/ooze_samples/helpers/shortcuts.rb

@@ -0,0 +1,77 @@
+module Eco
+  module API
+    class UseCases
+      class OozeSamples
+        module Helpers
+          module Shortcuts
+
+            # Offers multiple ways to compare two strings
+            def same_string?(value1, value2, exact: false)
+              case
+              when value1.is_a?(String) && value2.is_a?(String)
+                if exact
+                  value1 == value2
+                else
+                  value1.to_s.strip.downcase == value2.to_s.strip.downcase
+                end
+              when value1.is_a?(Regexp) && value2.is_a?(String)
+                value2 =~ value1
+              when value1.is_a?(String) && value2.is_a?(Regexp)
+                value1 =~ value2
+              else
+                value1 == value2
+              end
+            end
+
+            def titleize(str)
+              return nil unless str
+              return str if str.strip.empty?
+              str.split(/\s+/).map do |part|
+                part[0] = part[0].upcase
+                part[1..-1] = part[1..-1].downcase
+                part
+              end.join(" ")
+            end
+
+            def normalize_string(str)
+              return nil unless str
+              str.gsub(/[^[:print:]]/, '')
+              .gsub(/[[:space:]]+/, ' ')
+              .gsub(/[[:space:]]$/, '')
+              .gsub(/[-\u2011\u2012\u2013]/, '-').yield_self do |str|
+                str = yield(str) if block_given?
+                str
+              end
+            end
+
+            def clean_question(str)
+              return nil unless str
+              normalize_string(str) do |str|
+                str.gsub(/\r\n/, ' ').yield_self do |str|
+                  str = yield(str) if block_given?
+                  str
+                end
+              end
+            end
+
+            def object_reference(obj)
+              return "No reference" unless obj
+              "".tap do |ref|
+                case obj
+                when Ecoportal::API::V2::Page::Stage
+                  ref << "Stage"
+                when Ecoportal::API::V2::Pages::PageStage
+                  ref << "Page (#{obj.id}) (#{object_reference(obj.current_stage)})"
+                when Ecoportal::API::V2::Page
+                  ref << "Page"
+                end
+                ref << " '#{obj.name}'" if obj.respond_to?(:name)
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require_relative 'helpers/shortcuts.rb'
+
+module Eco
+  module API
+    class UseCases
+      class OozeSamples
+        module Helpers
+          include OozeSamples::Helpers::Shortcuts
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+# @attr_reader target [Ecoportal::API::V2::Page] current target ooze.
+class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders::UseCase
+  name "ooze-base"
+  type :other
+
+  include Eco::API::UseCases::OozeSamples::Helpers
+
+  attr_reader :session, :options, :usecase
+  attr_reader :target
+
+  SAVE_PATCH = "ooze_patch_update.json"
+  DRY_COUNT  = 5
+
+  def main(session, options, usecase)
+    raise "You need to inherit from this class ('#{self.class}') and call super with a block" unless block_given?
+    @session = session; @options = options; @usecase = usecase
+    @target  = nil
+    yield
+  end
+
+  # Write here your script
+  def process_ooze(ooze = target)
+    raise "You need to inherit from this class ('#{self.class}') and call super with a block" unless block_given?
+    yield(ooze)
+    update_ooze(ooze)
+  end
+
+  private
+
+  # Hook method to use before the target is switched
+  def before_loading_new_target(ooze_id)
+  end
+
+  def ooze(ooze_id = nil, stage_id: nil)
+    return target unless ooze_id
+    before_loading_new_target(ooze_id)
+    apiv2.pages.get(ooze_id, stage_id: stage_id).tap do |ooze|
+      if ooze
+        new_target(ooze)
+        logger.info("Got #{object_reference(ooze)}")
+      else
+        exit_error "Could not get ooze '#{ooze_id}'"
+      end
+    end
+  end
+
+  def stage(id_name = nil, ooze: target)
+    if ooze_id = ooze && ooze.id
+      exit_error "#{object_reference(ooze)} does not have stages!" unless ooze.stages?
+    else
+      exit_error "There's no target ooze to get retrieve stages from"
+    end
+
+    if stg = ooze.stages[id_name] || ooze.stages.get_by_name(id_name)
+      return ooze if ooze.respond_to?(:current_stage_id) && (ooze.current_stage_id == stg.id)
+      before_loading_new_target(ooze_id)
+      return apiv2.pages.get(ooze_id, stage_id: stg.id).tap do |stage|
+        if stage
+          new_target(stage)
+          logger.info("Got #{object_reference(stage)} from #{object_reference(ooze)}")
+        else
+          exit_error "Could not get stage '#{id_name}' in ooze '#{ooze_id}'"
+        end
+      end
+    end
+    exit_error "Stage '#{id_name}' doesn't exist in ooze '#{ooze_id}'"
+  end
+
+  def update_ooze(ooze = target)
+    if !options[:simulate]
+      return unless dirty?(ooze)
+      apiv2.pages.update(ooze).tap do |response|
+        if response.success?
+          ooze.consolidate!
+          logger.info("Successful update of #{object_reference(ooze)}")
+        else
+          logger.error("Could not update #{object_reference(ooze)} (created_at: #{ooze.created_at}: #{response.body}")
+        end
+      end
+    else
+      unless options.dig(:feedback, :only_stats)
+        if patch = (patch_doc(ooze) || {})["page"]
+          pp patch
+        end
+      end
+      backup_patch!(ooze)
+      exit(0) if dry_count > DRY_COUNT
+    end
+  end
+
+  def new_target(object, warn_pending_changes: true)
+    if dirty?(target)
+      if warn_pending_changes
+        msg =  "You you are switching to a new target #{object_reference(object)}"
+        msg += " after doing unsaved changes to #{object_reference(target)}"
+        logger.warn msg
+      end
+      yield(target) if block_given?
+    end
+    @target = object
+  end
+
+  def dirty?(object)
+    object && patch_doc(object)["page"]
+  end
+
+  def backup_patch!(ooze = target)
+    unless patch = (patch_doc(ooze) || {})["page"]
+      logger.info "No changes to update for #{object_reference(ooze)}."
+      return
+    end
+
+    patch = patch_doc(ooze)
+    # store the request
+    File.open(SAVE_PATCH, "w") do |file|
+      #file << (patch_doc || {}).to_json
+      file << JSON.pretty_generate(patch || {})
+    end
+    # TODO: ooze_requests folder with subfolders: for each run
+    puts "Saved patch at: #{File.expand_path(SAVE_PATCH)}"
+  end
+
+  def patch_doc(ooze = target)
+    apiv2.pages.get_body(ooze)
+  end
+
+  def dry_count
+    @dry_count ||= 0
+    @dry_count += 1
+  end
+
+  def apiv2
+   @apiv2 ||= session.api(version: :oozes)
+  end
+
+  def exit_error(msg)
+    logger.error(msg)
+    exit(1)
+  end
+
+
+end

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

@@ -0,0 +1,44 @@
+require 'docx'
+# Use case to abstract FORM from word document
+class Eco::API::UseCases::OozeSamples::OozeFromDocCase < Eco::API::UseCases::OozeSamples::OozeUpdateCase
+  name "ooze-forms-case"
+  type :other
+
+  private
+
+  def with_column(num = 0)
+    with_tables do |table, i|
+      raise "Column num (#{num}) is to big. Table '#{i}' only has #{table.column_count} columns." if table.column_count < num
+      table.columns[num].cells.each_with_index do |cell_row, j|
+        txt = normalize_string(cell_row.text)
+        yield(txt, i, j, table, cell_row)
+      end
+    end
+  end
+
+  def with_tables
+    raise "There are no tables in the doc" unless table_count > 0
+    i = 0
+    doc.tables.each do |table|
+      yield(table, i) if block_given?
+      i += 1
+    end
+  end
+
+  def table_count
+    doc.tables.count
+  end
+
+  def tables?
+    table_count > 0
+  end
+
+  def doc
+    @doc ||= Docx::Document.open(input_file)
+  end
+
+  def input_file
+    options.dig(:source, :file)
+  end
+
+end

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

@@ -0,0 +1,60 @@
+# Base class to run a script against a single ooze.
+class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::UseCases::OozeSamples::OozeBaseCase
+  name "ooze-run-base"
+  type :other
+
+  attr_reader :session, :options, :usecase
+
+  SAVE_PATCH = "ooze_patch_update.json"
+
+  def main(session, options, usecase, &block)
+    raise "You need to inherit from this class and call super with a block" unless block
+    @session = session; @options = options; @usecase = usecase
+    process_ooze(&block)
+  end
+
+  def process_ooze(ooze = target)
+    raise "You need to inherit from this class and call super with a block" unless block_given?
+    super(ooze) do
+      yield(ooze)
+      exit_if_no_changes!
+    end
+  end
+
+  private
+
+  def ooze
+    super(ooze_id, stage_id: stage_id)
+  end
+
+  def stage(stage_id_name = stage_id, ooze: target)
+    super(stage_id_name, ooze: ooze)
+  end
+
+  def ooze_id
+    options.dig(:source, :ooze_id)
+  end
+
+  def stage_id
+    options.dig(:source, :stage_id)
+  end
+
+  def update_ooze
+    prompt_to_confirm!
+    super
+  end
+
+  def exit_if_no_changes!
+    unless changes = !!patch_doc["page"]
+      logger.warn "No Changes!!"
+      exit(0)
+    end
+  end
+
+  def prompt_to_confirm!
+    micro.prompt_user("Do you want to proceed (y/N)?", default: "Y") do |response|
+      exit(1) unless response.upcase.start_with?("Y")
+    end
+  end
+
+end

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

@@ -1,132 +1,54 @@
-class Eco::API::UseCases::OozeSamples::OozeUpdateCase < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::OozeSamples::OozeUpdateCase < Eco::API::UseCases::OozeSamples::OozeRunBaseCase
   name "single-ooze-case"
   type :other
 
-  attr_reader :session, :options, :usecase
-
-  SAVE_PATCH = "ooze_patch_update.json"
-
-  def main(session, options, usecase)
-    @session = session; @options = options; @usecase = usecase
-    yield
-    end_script!
-  end
-
   private
 
-  def end_script!
-    exit_if_no_changes!
-    backup_patch!
-    launch_request unless options[:simulate]
-    exit(0)
-  end
-
-  def ooze_id
-    options.dig(:source, :ooze_id)
-  end
-
-  def stage_id
-    options.dig(:source, :stage_id)
-  end
-
-  def stage(id_name = stage_id)
-    if stg = ooze.stages[id_name] || ooze.stages.get_by_name(id_name)
-      return apiv2.pages.get(ooze_id, stage_id: stg.id).tap do |stage|
-        if stage
-          new_target(stage)
-          logger.info("Got #{object_reference(stage)} from #{object_reference(ooze)}")
-        else
-          logger.error("Could not get stage '#{id_name}' in ooze '#{ooze_id}'")
-          exit(1)
-        end
-      end
+  def with_fields(type: nil, label: nil)
+    flds = target.components
+    flds = flds.get_by_type(type) if type
+    flds = flds.select do |fld|
+      value = (label == :unnamed) ? nil : label
+      !label || same_string?(fld.label, value)
+    end.each do |field|
+      yield(field) if block_given?
     end
-    raise "Stage '#{id_name}' doesn't exist in ooze '#{ooze_id}'"
   end
 
-  def ooze
-    @ooze ||= apiv2.pages.get(ooze_id).tap do |ooze|
-      if ooze
-        new_target(ooze)
-        logger.info("Got #{object_reference(ooze)}")
-      else
-        logger.error("Could not get ooze '#{ooze_id}'")
-        exit(1)
-      end
+  def with_sections(type: nil, heading: nil)
+    secs = target.sections
+    secs = secs.get_by_type(type) if type
+    secs = secs.select do |sec|
+      value = (heading == :unnamed) ? nil : heading
+      !heading || same_string?(sec.heading, value)
+    end.each do |sec|
+      yield(sec) if block_given?
     end
   end
 
-  def launch_request
-    prompt_to_confirm!
-
-    apiv2.pages.update(target).tap do |response|
-      if response.success?
-        logger.info("All went OK")
-      else
-        logger.error(response.body)
-      end
+  def with_stage(name:)
+    if stage = target.stages.get_by_name(name)
+      yield(stage) if block_given?
     end
+    stage
   end
 
-  def exit_if_no_changes!
-    unless changes = !!patch_doc["page"]
-      logger.warn "No Changes!!"
-      exit(0)
+  def add_field(name, type, section, after:  nil, side: :left)
+    raise "You need to specify a section for a new field. Given: #{section.class}" unless section.is_a?(Ecoportal::API::V2::Page::Section)
+    target.components.add(label: name, type: type) do |field|
+      section.add_component(field, after: after, side: side)
+    end.tap do |field|
+      yield(field) if block_given?
     end
   end
 
-  def apiv2
-   @apiv2 ||= session.api(version: :oozes)
+  def to_field(value)
+    fld   = nil
+    fld ||= value if value.is_a?(Ecoportal::API::V2::Page::Component)
+    fld ||= target.components.get_by_id(value)
+    fld ||= target.components.select {|fld| same_name?(fld.label, value)}
+    #fld ||= value.reference if value.is_a?(Ecoportal::API::V2::Page::Force::Binding)
   end
 
-  def target
-    @target
-  end
-
-  def new_target(object)
-    if @target && patch_doc["page"]
-      logger.warn "You you are switching to a new target #{object_reference(object)} after doing unsaved changes to #{object_reference(@target)}"
-    end
-    @target = object
-  end
-
-  def object_reference(obj)
-    return "No reference" unless obj
-    "".tap do |ref|
-      case obj
-      when Ecoportal::API::V2::Page::Stage
-        ref << "Stage "
-      when Ecoportal::API::V2::Pages::PageStage
-        ref << "StagePage "
-      when Ecoportal::API::V2::Page
-        ref << "Page "
-      end
-      ref << "'#{obj.name}' " if obj.respond_to?(:name)
-    end
-  end
-
-
-  def patch_doc
-    apiv2.pages.get_body(target)
-  end
-
-  def backup_patch!
-    # store the request
-    File.open(SAVE_PATCH, "w") do |file|
-      #file << (patch_doc || {}).to_json
-      file << JSON.pretty_generate(patch_doc || {})
-    end
-    puts "Saved patch at: #{File.expand_path(SAVE_PATCH)}"
-  end
-
-  def logger
-    session.logger
-  end
-
-  def prompt_to_confirm!
-    prompt_user("Do you want to proceed (y/N)?", default: "Y") do |response|
-      exit(1) unless response.upcase.start_with?("Y")
-    end
-  end
 
 end

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

@@ -0,0 +1,160 @@
+# Use case to update a register
+# @note
+#   - You can define methods `filters` and `search` to change the target entries of the register
+#   - You need to define the `process_ooze` method
+# This case expects `options[:source][:register_id]`
+class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::OozeSamples::OozeBaseCase
+
+  class << self
+    # @return [Integer] the number of pages to be processed in each batch
+    def batch_size(size = nil)
+      @batch_size ||= 25
+      return @batch_size unless size
+      @batch_size = size
+    end
+  end
+
+  name "register-update-case"
+  type :other
+
+  def main(session, options, usecase, &block)
+    super(session, options, usecase) do
+      with_each_entry do |ooze|
+        process_ooze(&block)
+      end
+    end
+  end
+
+  def process_ooze(ooze = target)
+    raise "You need to define this method"
+  end
+
+  private
+
+  def before_loading_new_target(ooze_id)
+    if pending = queue_shift(ooze_id)
+      update_ooze(pending)
+    end
+  end
+
+  def new_target(object, warn_pending_changes: false)
+    enqueue(object)
+    super(object, warn_pending_changes: warn_pending_changes) do |pending|
+      #queue(pending)
+    end
+  end
+
+  def with_each_entry
+    batched_search_results do |page_results|
+      page_results.each do |page_result|
+        if pending = queue_shift(page_result.id)
+          if dirty?(pending)
+            msg  = "Inconsistent search results. "
+            msg << "Launching update on '#{object_reference(pending)}' to be able to queue it back"
+            console.warn msg
+            update_ooze(pending)
+          end
+        end
+        if ooz = ooze(page_result.id)
+          yield(ooz)
+        end
+      end
+      update_oozes
+    end
+  end
+
+  def enqueue(object)
+    return unless object && object.respond_to?(:id)
+    if elem = queue_get(object.id)
+      msg = "Something is wrong. Native case 'RegisterUpdateCase' is "
+      if (elem != object) && dirty?(elem)
+        msg << "trying to queue different objects with same page id:\n"
+        msg << " • already queued (changes will go): #{object_reference(elem)}\n"
+        msg << " • tried to queue (lost changes): #{object_reference(object)}"
+        logger.warn msg
+      end
+    else
+      batch_queue << object unless batch_queue.include?(object)
+    end
+  end
+
+  def queue_shift(id = nil)
+    if id
+      batch_queue.delete(queue_get(id))
+    else
+      batch_queue.shift
+    end
+  end
+
+  def queue_get(id)
+    batch_queue.find {|e| e.id == id}
+  end
+
+  def batch_queue
+    @batch_queue ||= []
+  end
+
+  def batched_search_results
+    raise "Missing block. It yields in slices of #{self.class.batch_size} results" unless block_given?
+    results_preview
+    results = []
+    apiv2.registers.search(register_id, search_options) do |page_result|
+      results << page_result
+      if results.length >= self.class.batch_size
+        yield(results)
+        results = []
+      end
+    end
+    yield(results) unless results.empty?
+  end
+
+  def update_oozes(batched_oozes = batch_queue)
+    batched_oozes.each do |ooze|
+      update_ooze(ooze)
+    end
+    batched_oozes.clear
+  end
+
+  def backup_patch!(ooze = target)
+    unless patch = (patch_doc(ooze) || {})["page"]
+      logger.info "No changes to update for #{object_reference(ooze)}."
+      return
+    end
+  end
+
+  def results_preview
+    apiv2.registers.search(register_id, search_options.merge(only_first: true)).tap do |search_results|
+      str_results = "Total target entries: #{search_results.total} (out of #{search_results.total_before_filtering})"
+      session.prompt_user("Do you want to proceed (y/N):", explanation: str_results, default: "N", timeout: 10) do |res|
+        if res.upcase.start_with?("N")
+          puts "..."
+          logger.info "Aborting script..."
+          exit(0)
+        end
+      end
+    end
+  end
+
+  def search_options
+    @search_options ||= {}.tap do |opts|
+      opts.merge!(sort: "created_at")
+      opts.merge!(dir:  "asc")
+      opts.merge!(query:   conf_filters) if conf_search
+      opts.merge!(filters: conf_filters)
+    end
+  end
+
+  def conf_filters
+    return filters if self.respond_to?(:filters)
+    []
+  end
+
+  def conf_search
+    return search if self.respond_to?(:search)
+  end
+
+  def register_id
+    options.dig(:source, :register_id)
+  end
+
+end

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

@@ -8,4 +8,9 @@ module Eco
   end
 end
 
+require_relative 'ooze_samples/helpers'
+require_relative 'ooze_samples/ooze_base_case'
+require_relative 'ooze_samples/ooze_run_base_case'
 require_relative 'ooze_samples/ooze_update_case'
+require_relative 'ooze_samples/ooze_from_doc_case'
+require_relative 'ooze_samples/register_update_case'

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.31"
+  VERSION = "2.0.35"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.31
+  version: 2.0.35
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.8.12
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.8.12
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -350,6 +350,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: docx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: 
 email:
 - oscar@ecoportal.co.nz
@@ -537,7 +557,13 @@ files:
 - lib/eco/api/usecases/default_cases/update_details_case.rb
 - lib/eco/api/usecases/default_cases/upsert_case.rb
 - lib/eco/api/usecases/ooze_samples.rb
+- lib/eco/api/usecases/ooze_samples/helpers.rb
+- lib/eco/api/usecases/ooze_samples/helpers/shortcuts.rb
+- lib/eco/api/usecases/ooze_samples/ooze_base_case.rb
+- lib/eco/api/usecases/ooze_samples/ooze_from_doc_case.rb
+- lib/eco/api/usecases/ooze_samples/ooze_run_base_case.rb
 - lib/eco/api/usecases/ooze_samples/ooze_update_case.rb
+- lib/eco/api/usecases/ooze_samples/register_update_case.rb
 - lib/eco/api/usecases/use_case.rb
 - lib/eco/api/usecases/use_case_chain.rb
 - lib/eco/api/usecases/use_case_io.rb