eco-helpers 2.0.44 → 2.0.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aea821da02fcbce6d1bbafb10f4bd0c120b71d3a5a6fcb00a5aad9232b52acf9
-  data.tar.gz: 547a2d4a2f5e0c32a51bcb579e342805dd28ffafb99c1dd53c1c079a90755079
+  metadata.gz: f85bd156250d1f44ca911d98007005cbbb2281ff4a40a2fc07a80680fd42a408
+  data.tar.gz: 4ccda90fbf7d1bbfc814d18cd033110b7af2ae366687af1fa2db10370788c52d
 SHA512:
-  metadata.gz: 475aa0acbe5543f9bbd349fbde2405ef2c492d46ca7493a14eb1d3912b698a9ca9c41bba4f159294c3b39a0cc9a1b34e7cafba61336ccbdfeb07e2d6fe7c9668
-  data.tar.gz: 41e29bfef6ad83509402cf365d292010f730d27fe5e1a25a7579cce5bf16d62c070ce53433e29affc47d3e0dbc17e4aeb29cbb2612bba6fcb0ac87fe7742e026
+  metadata.gz: f4b7add6e04fb8b4dfa0c56371bc3f85e791659754e937f60586b88dec06186723f9286c87482144bd9b012298dbc03251388c49f1245008026a186cd6d16a88
+  data.tar.gz: 7a0bfda7154a8c0e7bb7e18100a96cd2a45f26a6d45309725e7d796dd9d0ad48cefb35be551c031706757d1241fab7505d74f401cf6a04764547bbe8c582e076

data/CHANGELOG.md

@@ -1,15 +1,22 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.44] - 2021-11-xx
+## [2.0.45] - 2021-11-xx
 
 ### Added
-
+  - `Eco::API::UseCases::OozeSamples::RegisterExportCase`
+  
 ### Changed
   - Upgrade `ecoportal-api` dependency
-  
+  - Upgrade `ecoportal-api-v2` dependency
+
 ### Fixed
 
+## [2.0.44] - 2021-11-25
+
+### Changed
+  - Upgrade `ecoportal-api` dependency
+
 ## [2.0.43] - 2021-11-25
 
 ### Added

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.4', '< 0.9'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.19', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.21', '< 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/ooze_samples/register_export_case.rb

@@ -0,0 +1,184 @@
+# 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::RegisterExportCase < Eco::API::Common::Loaders::UseCase
+
+  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
+
+  include Eco::API::UseCases::OozeSamples::Helpers
+
+  name "register-export-case"
+  type :other
+
+  attr_reader :session, :options, :usecase
+  attr_reader :target
+
+  def main(session, options, usecase)
+    options[:end_get] = false
+    @session = session; @options = options; @usecase = usecase
+    @target  = nil
+    raise "You need to inherit from this class ('#{self.class}') and call super with a block" unless block_given?
+    with_each_entry do |ooze|
+      process_ooze(ooze)
+    end
+    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)
+  end
+
+  private
+
+  def new_target(object)
+    @target = object
+  end
+
+  def with_each_entry
+    batched_search_results do |page_results|
+      page_results.each do |page_result|
+        if ooz = build_full_ooze(page_result.id)
+          yield(ooz)
+        end
+      end
+    end
+  end
+
+  # It builds a full page model (not updatable)
+  # @note If it's a page instance with stages, there's where it will be handy
+  # @param ooze_id [String]
+  # @return [Ecoportal::API::V2::Page]
+  def build_full_ooze(ooze_id)
+    if page = ooze(ooze_id)
+      return page unless page.is_a?(Ecoportal::API::V2::Pages::PageStage)
+      secs_doc = page.sections.doc
+      flds_doc = page.components.doc
+      pending_stage_ids = page.stages.map(&:id) - [page.current_stage_id]
+      pending_stage_ids.each do |id|
+        if page = stage(id, ooze: page)
+          page.sections.doc.each do |sec_doc|
+            unless secs_doc.find {|sec| sec["id"] == sec_doc["id"]}
+              secs_doc << sec_doc
+            end
+          end
+          page.components.doc.each do |comp_doc|
+            unless flds_doc.find {|fld| fld["id"] == comp_doc["id"]}
+              flds_doc << comp_doc
+            end
+          end
+        end
+      end
+      Ecoportal::API::V2::Page.new(page.doc)
+    end
+  end
+
+  #def update_oozes(batched_oozes = batch_queue)
+  #  batched_oozes.each do |ooze|
+  #    update_ooze(ooze)
+  #  end
+  #  batched_oozes.clear
+  #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 ooze(ooze_id = nil, stage_id: nil)
+    return target unless 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)
+      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 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|
+        unless res.upcase.start_with?("Y")
+          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_search) 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
+
+  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.rb

@@ -10,6 +10,7 @@ end
 
 require_relative 'ooze_samples/helpers'
 require_relative 'ooze_samples/ooze_base_case'
+require_relative 'ooze_samples/register_export_case'
 require_relative 'ooze_samples/ooze_run_base_case'
 require_relative 'ooze_samples/ooze_update_case'
 require_relative 'ooze_samples/ooze_from_doc_case'

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.44"
+  VERSION = "2.0.45"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.44
+  version: 2.0.45
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.19
+        version: 0.8.21
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.19
+        version: 0.8.21
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -564,6 +564,7 @@ files:
 - 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_export_case.rb
 - lib/eco/api/usecases/ooze_samples/register_update_case.rb
 - lib/eco/api/usecases/ooze_samples/target_oozes_update_case.rb
 - lib/eco/api/usecases/use_case.rb