eco-helpers 2.0.33 → 2.0.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84ad4121fdba090ce8585df6a999c91a0a1ba5c8fa67d52f6dc4ec5d39da18b9
-  data.tar.gz: 96e540e97b6a54a92e246fd794821002ab015c9199d033bcb22abbc2bd729a69
+  metadata.gz: 0a1e3f56c23a45ecb80f852556b02b1ac7cc3a2546a72bcb5d2d05283bbc66b6
+  data.tar.gz: 82250daa8e645c1a68d79d047d938fd3371c909d9eeb04dca58548d5bd907543
 SHA512:
-  metadata.gz: a6a3c9b2920974830e3d9ea1619f9f4e2f8652112d0b0683526888cd9d29c29c61e35afe53d94bd0927ddb4b8bd621827cdf5a8a18830143f6549f7b3d8fc37d
-  data.tar.gz: ceaf87bc2b6190f70c91f9ad09da865ecb064bd1be9f783a75cb91f531a9918ee80a1d583ba74c21ab56ac9863eccd6d6c3321b78988961762335e80036f4ed6
+  metadata.gz: d93e88f2f6dab9ca740d7c21741be6c6aec2885c98336fe7d0d247964e995b519603aaf989872073a3ff93234f64cce3cb62bece56ed4c33d7597de186f70bae
+  data.tar.gz: 4cd351d33ef0f66d178273d64ba52b39356204a8b31aabc358bda6267892af678c785b17537eb2ca2b00533a81b2ee600b3e648f40891b4438162a7362d33825

data/CHANGELOG.md

@@ -1,7 +1,57 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.33] - 2021-08-xx
+## [2.0.37] - 2021-09-03
+
+### Added
+### Changed
+
+### Fixed
+  - `Eco::API::UseCases::OozeSamples::OozeBaseCase`
+    - `#update_ooze` only count dry run for changed pages (to have better feedack)
+    - stop downloading the people manager
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase`
+    - prevent queuing non page objects
+    
+## [2.0.36] - 2021-08-31
+
+### Fixed
+  - `Eco::API::UseCases::OozeSamples::OozeBaseCase`
+    - `#update_ooze` only count dry run for changed pages (to have better feedack)
+
+## [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

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.9', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.13', '< 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'

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

@@ -54,6 +54,21 @@ module Eco
               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

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

@@ -0,0 +1,143 @@
+# @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)
+    options[:end_get] = false
+    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 dirty?(ooze) && 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

@@ -4,13 +4,6 @@ class Eco::API::UseCases::OozeSamples::OozeFromDocCase < Eco::API::UseCases::Ooz
   name "ooze-forms-case"
   type :other
 
-  def main(session, options, usecase)
-    raise "You need to inherit from this class and call super with a block" unless block_given?
-    super(session, options, usecase) do
-      yield
-    end
-  end
-
   private
 
   def with_column(num = 0)

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

@@ -1,4 +1,5 @@
-class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::Common::Loaders::UseCase
+# 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
 
@@ -6,20 +7,28 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::Common::Loade
 
   SAVE_PATCH = "ooze_patch_update.json"
 
-  def main(session, options, usecase)
-    raise "You need to inherit from this class and call super with a block" unless block_given?
+  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
-    yield
-    end_script!
+    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 end_script!
-    exit_if_no_changes!
-    backup_patch!
-    launch_request unless options[:simulate]
-    exit(0)
+  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
@@ -30,54 +39,9 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::Common::Loade
     options.dig(:source, :stage_id)
   end
 
-  def target
-    @target ||= ooze
-  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 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
-    end
-    raise "Stage '#{id_name}' doesn't exist in ooze '#{ooze_id}'"
-  end
-
-  def ooze
-    @ooze ||= apiv2.pages.get(ooze_id, stage_id: stage_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
-    end
-  end
-
-  def launch_request
+  def update_ooze
     prompt_to_confirm!
-
-    apiv2.pages.update(target).tap do |response|
-      if response.success?
-        logger.info("All went OK")
-      else
-        logger.error(response.body)
-      end
-    end
+    super
   end
 
   def exit_if_no_changes!
@@ -87,46 +51,10 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::Common::Loade
     end
   end
 
-  def apiv2
-   @apiv2 ||= session.api(version: :oozes)
-  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 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 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
 
-  def logger
-    session.logger
-  end
-
 end

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

@@ -2,15 +2,6 @@ class Eco::API::UseCases::OozeSamples::OozeUpdateCase < Eco::API::UseCases::Ooze
   name "single-ooze-case"
   type :other
 
-  include Eco::API::UseCases::OozeSamples::Helpers
-
-  def main(session, options, usecase)
-    raise "You need to inherit from this class and call super with a block" unless block_given?
-    super(session, options, usecase) do
-      yield
-    end
-  end
-
   private
 
   def with_fields(type: nil, label: nil)

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

@@ -0,0 +1,163 @@
+# 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|
+      #enqueue(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)
+    unless object.is_a?(Ecoportal::API::V2::Page) or object.is_a?(Ecoportal::API::V2::Pages::PageStage)
+      raise "Queuing is just for entries. Expecting Page or PageStage. Given: #{object.class}"
+    end
+    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

@@ -9,6 +9,8 @@ module Eco
 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.33"
+  VERSION = "2.0.37"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.33
+  version: 2.0.37
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.9
+        version: 0.8.13
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.9
+        version: 0.8.13
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -559,9 +559,11 @@ files:
 - 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