eco-helpers 2.0.29 → 2.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89eb45172e9558ceb184ec289f435c5d2d853d8c7740f7922b0f3fe8727341a3
-  data.tar.gz: 7419eaed8d878f2f7d333928683a6f03ddeec94c13fa1fceabb716f8ece9cc4a
+  metadata.gz: 84ad4121fdba090ce8585df6a999c91a0a1ba5c8fa67d52f6dc4ec5d39da18b9
+  data.tar.gz: 96e540e97b6a54a92e246fd794821002ab015c9199d033bcb22abbc2bd729a69
 SHA512:
-  metadata.gz: '00395c4a6f51be7b846a37db9bb9b407ef21dbf8e86f76c41a58cb6ac9a34341f3a9c399d41de14a0f5922b46d9ee7b812750d9db7b1c7b7f4c131f5c17fb0aa'
-  data.tar.gz: df59209eaf8b90dfe43019150b0569398a0fb26ad96894da2641ad453a1d3aa815495ce9f035555a8f7a804689d931dc43e0882022a705bb9f1a650f75cae996
+  metadata.gz: a6a3c9b2920974830e3d9ea1619f9f4e2f8652112d0b0683526888cd9d29c29c61e35afe53d94bd0927ddb4b8bd621827cdf5a8a18830143f6549f7b3d8fc37d
+  data.tar.gz: ceaf87bc2b6190f70c91f9ad09da865ecb064bd1be9f783a75cb91f531a9918ee80a1d583ba74c21ab56ac9863eccd6d6c3321b78988961762335e80036f4ed6

data/CHANGELOG.md

@@ -1,11 +1,39 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.29] - 2021-07-08
+## [2.0.33] - 2021-08-xx
 
 ### 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.
+
+## [2.0.30] - 2021-07-08
+
+### Added
+  * `Eco::API::Common::People::DefaultParsers::XLSParser` uses as default the `fields_map.json` to identify the headers.
+
+### Fixed
+  * `Eco::API::Common::People::DefaultParsers::XLSParser` should return all `String` values
+
+## [2.0.29] - 2021-07-08
 
 ### Fixed
   - `Eco::API::Common::People::PersonEntryAttributeMapper#details_attrs`
@@ -75,9 +103,6 @@ All notable changes to this project will be documented in this file.
     * when in `dry-run` it fakes the `id` with a counter
   - `Eco::API::Common::People::PersonFactory` gets `subordinates` initialized to `0` (when **creating** a `new` person)
 
-### Fixed
-
-
 ## [2.0.25] - 2021-06-23
 
 ### 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.3', '< 0.9'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.7', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.9', '< 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/common/loaders/base.rb

@@ -5,7 +5,7 @@ module Eco
         class Base
           extend Eco::API::Common::ClassHelpers
 
-          class << self              
+          class << self
             # Sort order
             def <=>(other)
               created_at <=> other.created_at

data/lib/eco/api/common/people/default_parsers/xls_parser.rb

@@ -6,7 +6,12 @@ class Eco::API::Common::People::DefaultParsers::XLSParser < Eco::API::Common::Lo
 
   def parser(file, deps)
     @file = file
-    rows.tap {|r| @file = nil}
+    rows.tap do |rws|
+      @file = nil
+      rws.each do |row|
+        to_string!(row)
+      end
+    end
   end
 
   def serializer(array_hash, deps)
@@ -15,8 +20,18 @@ class Eco::API::Common::People::DefaultParsers::XLSParser < Eco::API::Common::Lo
 
   private
 
+  def to_string!(row)
+    row.transform_values! do |val|
+      next nil unless val
+      next val if val.is_a?(String)
+      val.to_s
+    end
+  end
+
+
   def headers
-    raise "You should implement this method"
+    logger.warn("Headers detection is using your fields_map.json file (native behaviour)")
+    session.fields_mapper.list(:external).uniq
   end
 
   def sheet_name
@@ -34,7 +49,7 @@ class Eco::API::Common::People::DefaultParsers::XLSParser < Eco::API::Common::Lo
 
   def rows(target = headers)
     begin
-      spreadheet.parse(header_search: target)
+      spreadheet.parse(header_search: target, clean: true)
     rescue Roo::HeaderRowNotFoundError => e
       missing  = JSON.parse(e.message)
       logger.warn("The input file is missing these headers: #{missing}")

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/session/batch/job.rb

@@ -252,13 +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
-            if options.dig(:include, :excluded, :only)
-              full_queue.select {|entry| excluded.call(entry, session, options, self)}
+            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_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/usecases/ooze_samples.rb

@@ -8,4 +8,7 @@ module Eco
   end
 end
 
+require_relative 'ooze_samples/helpers'
+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/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/helpers/shortcuts.rb

@@ -0,0 +1,62 @@
+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
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+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
+
+  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)
+    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,132 @@
+class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::Common::Loaders::UseCase
+  name "ooze-run-base"
+  type :other
+
+  attr_reader :session, :options, :usecase
+
+  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?
+    @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 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
+    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
+  end
+
+  def exit_if_no_changes!
+    unless changes = !!patch_doc["page"]
+      logger.warn "No Changes!!"
+      exit(0)
+    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

@@ -1,132 +1,63 @@
-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"
+  include Eco::API::UseCases::OozeSamples::Helpers
 
   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
-    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
+    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
 
-  def launch_request
-    prompt_to_confirm!
+  private
 
-    apiv2.pages.update(target).tap do |response|
-      if response.success?
-        logger.info("All went OK")
-      else
-        logger.error(response.body)
-      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
   end
 
-  def exit_if_no_changes!
-    unless changes = !!patch_doc["page"]
-      logger.warn "No Changes!!"
-      exit(0)
+  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 apiv2
-   @apiv2 ||= session.api(version: :oozes)
-  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)}"
+  def with_stage(name:)
+    if stage = target.stages.get_by_name(name)
+      yield(stage) if block_given?
     end
-    @target = object
+    stage
   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)
+  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 patch_doc
-    apiv2.pages.get_body(target)
+  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 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/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.29"
+  VERSION = "2.0.33"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.29
+  version: 2.0.33
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.8.9
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.8.9
     - - "<"
       - !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,6 +557,10 @@ 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_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/use_case.rb
 - lib/eco/api/usecases/use_case_chain.rb