eco-helpers 2.0.2 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37b6126eddfc0f3ef3c32f621fd0c6d15e5b1e15e83e539a52d331ebe59d8d16
-  data.tar.gz: 838d28773e4175fe9948243dd0145ee184d6c1329a1c4fb772743db146261465
+  metadata.gz: b444c56a85b8fb8ce11e4b9201222adcb135c841eecece4b9e98f8bd6274b479
+  data.tar.gz: fca867adb3b83aeb1ab4473d76e69e9ff5ee4c4852c9e938317f656b1056fb53
 SHA512:
-  metadata.gz: daa1ee54fdf2aa3bb983ef4ca8c813c4e6778cea94f32777854fbb157864d80c9eb2120007fbbd4c9a47c3b84d72ca4f671f3f64c8bf0bbafca6385d490e7437
-  data.tar.gz: 8370f7da5acf41bc0951ed0fee5822bea43e128d8de34a3c84e626d60ad9ade2686bb0911af11e35b0197f8e67d9073826ff0f6b9b4dca4f5c78a73e9297b031
+  metadata.gz: 9a52c4b75a3093854de42d9f1a633e30faeb4b70e56322cc7252a5b5b8d581296afb53c32eaba209965366f7f4d398a73e3ecfaf3c03738e6b9b124a18ba4512
+  data.tar.gz: ab33ad8f29467b3844e3f43c407f3534228814c3915e63c72095bb9f2396f2f31b6cbd9dca9102472b75907dd908b3f529f1695479396cf5400b792e8ac0ed2f

data/CHANGELOG.md

@@ -1,7 +1,48 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.2] - 2021-02-xx
+## [2.0.7] - 2021-03-xx
+
+### Added
+### Changed
+### Fixed
+  - `Eco::API::Session::Batch::JobsGroups` and `Eco::API::Session::Batch::Jobs`: when new `Batch::Job`s are creating during launch, they remained unlaunched
+    - this fix makes `#launch` method to iterate until there are no pending
+
+## [2.0.6] - 2021-03-08
+
+### Added
+### Changed
+  - `Eco::API::Session::Batch:Errors` moved some methods to be private
+### Fixed
+  - `Eco::API::Error` should inherit from `StandardError`, rather than from `Exception`
+
+## [2.0.5] - 2021-02-24
+
+### Added
+### Changed
+### Fixed
+  - `Eco::API::Common::People::PersonParser#symbol_keys` to use `Array#select`
+    - as `Array#filter` was introduced in ruby `2.5.5`
+
+## [2.0.4] - 2021-02-23
+
+### Added
+### Changed
+  - `Eco::API::Common::People::PersonParser#defined_attrs` to include virtual attributes
+
+### Fixed
+
+## [2.0.3] - 2021-02-23
+
+### Added
+  - `Eco::API::UseCases::OozeSamples::OozeUpdateCase`: added integration to update page instances (non-templates)
+
+### Changed
+### Fixed
+  - `Eco::API::Policies::DefaultPolicies::UserAccess` complete default policy code.
+
+## [2.0.2] - 2021-02-22
 
 ### Added
 ### Changed

data/eco-helpers.gemspec

@@ -30,9 +30,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard",      ">= 0.9.26", "< 0.10"
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
 
-  spec.add_dependency 'ecoportal-api', '>= 0.8.1', '< 0.9'
+  spec.add_dependency 'ecoportal-api', '>= 0.8.2', '< 0.9'
   #spec.add_dependency 'ecoportal-api', '>= 0.7.5', '< 0.8'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.3', '< 0.9'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.6', '< 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/common/people/person_parser.rb

@@ -99,9 +99,16 @@ module Eco
           #  - the list is sorted according `CORE_ATTRS` + `ACCOUNT_ATTRS` + schema attrs
           # @return [Array<String>] list of all attribute defined parsers.
           def defined_attrs
-            defined = @parsers.keys
-            defined = (all_attrs || defined) && defined
-            defined - (defined - all_attrs)
+            defined     = @parsers.keys
+            defined     = (all_attrs | defined) & defined
+            defined - symbol_keys
+          end
+
+          # Symbol keys are type or import parsers (that do not belong to the model)
+          # @note this was introduced to boost virtual fields to treat in different phases of the parsing process
+          # @return [Array<Symbol>] all the parsers defined as Symbol
+          def symbol_keys
+            @parsers.keys.select {|k| k.is_a?(Symbol)}
           end
 
           # Returns a list of all the internal attributes of the model that have a parser defined & that should be active.

data/lib/eco/api/error.rb

@@ -1,8 +1,8 @@
 module Eco
   module API
     # To identify api server errors
-    class Error < Exception
-      class UnknownErrorClass < Exception
+    class Error < StandardError
+      class UnknownErrorClass < StandardError
         def initialize(msg = nil, klass:)
           msg ||= "Unkown api error class #{klass}"
           super(msg)

data/lib/eco/api/policies/default_policies/99_user_access_policy.rb

@@ -1,18 +1,18 @@
 class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loaders::Policy
   name "default-user-access"
 
-  attr_reader :session, :options
+  attr_reader   :session, :options, :job
   attr_accessor :account_removed_count
 
   def main(people, session, options, policy, job)
-    @session = session; @options = options
+    @session = session; @options = options; @job = job
 
     self.account_removed_count = 0
 
     people.each do |person|
-      remove_account_when_no_email!(person)      if person.email.to_s.empty?
-      person.account.policy_group_ids = [defid]  if no_policy_group_ids?(person)
-      refresh_abilities!(person.account)
+      remove_account_when_no_email!(person)    if person.email.to_s.empty?
+      person.account.policy_group_ids = defid  if no_policy_group_ids?(person)
+      refresh_abilities!(person)
     end
 
     warn_account_removal!
@@ -22,14 +22,14 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
 
   def warn_account_removal!
     if account_removed_count > 0
-      msg = "Removed account to #{account_removed_count} people"
+      msg = "(DefaultPolicy on job '#{job.name}') Removed account to #{account_removed_count} people"
       session.logger.warn(msg)
     end
   end
 
   def remove_account_when_no_email!(person)
     if person.account
-      account_removed_count += 1 if had_account?(person)
+      self.account_removed_count += 1 if had_account?(person)
       person.account = nil
     end
   end
@@ -40,23 +40,11 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
     return !!person.original_doc["account"]
   end
 
-  def provision_basic_level!(person)
-    if account = person.account
-
-      unless options.dig(:exclude, :abilities)
-        account.permissions_custom = session.new_preset(person)
-
-        if no_abilities?(person)
-          account.permissions_custom = min_abilities
-        end
-      end
-
-    end
-  end
-
-  def refresh_abilities!(account)
-    return nil unless account
-
+  def refresh_abilities!(person)
+    return nil if options.dig(:exclude, :abilities)
+    return nil unless account = person.account
+    account.permissions_custom = session.new_preset(person)
+    account.permissions_custom = min_abilities if no_abilities?(person)
   end
 
   def no_policy_group_ids?(person)
@@ -64,8 +52,8 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
   end
 
   def no_abilities?(person)
-    person.account.permissions_custom &&
-    person.account.permissions_custom.values.all?(&:nil?)
+    return true unless account = person.account
+    account.permissions_custom && account.permissions_custom.values.all?(&:nil?)
   end
 
   def min_abilities
@@ -86,7 +74,7 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
   end
 
   def defid
-    @defid ||= policy_groups.to_id(default_group)
+    @defid ||= policy_groups.to_id([default_group]).compact
   end
 
   def default_group

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

@@ -8,6 +8,8 @@ module Eco
           # @attr_reader status [Eco::API::Session::Batch::Status] `batch status` this `Errors` object is associated to.
           attr_reader :status
 
+          ErrorCache = Struct.new(:type, :err, :entry)
+
           # @param status [Eco::API::Session::Batch::Status] `batch status` this `Errors` object is associated to.
           def initialize(status:)
             "Expected Batch::Status as root. Given: #{status.class}" unless status.is_a?(Eco::API::Session::Batch::Status)
@@ -55,29 +57,6 @@ module Eco
             entries.length
           end
 
-          # Input entries that got **error** response from the _Server_.
-          # @raise [Exception] if there are elements of the final `queue` that did not get response
-          # @note discards those that did not get _response_ from the Server (so those that were not queried)
-          #   - please, observe that this can only happen if there were repeated entries in the `source_queue`
-          # @return [Array<Hash>, Array<Ecoportal::API::V1::Person>, Array<Ecoportal::API::Internal::Person>]
-          def entries
-            queue.each_with_index.map do |query, i|
-              unless response = status[i]
-                msg  = "Error: query with no response. You might have duplicated entries in your queue.\n"
-                msg += "Queue length: #{queue.length}; Queue elements class: #{queue.first.class}\n"
-                msg += "Query with no response. Person: #{person_ref(query)}\n"
-                queue.map do |entry|
-                  if [:id, :external_id, :email].any? {|attr| (v = get_attr(entry, attr)) && v == get_attr(query, attr)}
-                    msg += "It could be this peson entry (idx: #{to_index(entry)}): #{person_ref(entry)}\n"
-                  end
-                end
-                raise msg
-              end
-
-              response.success?? nil : query
-            end.compact
-          end
-
           # For all the `entries` with errors generates a `Hash` object
           # @return [Array<Hash>] where each `Hash` has
           #   1. `:type` -> the error type
@@ -88,11 +67,11 @@ module Eco
               if body = status[entry].body
                 if errs = body["errors"]
                   errs.each do |msg|
-                    arr.push({
-                      type:  klass = Eco::API::Error.get_type(msg),
-                      err:   klass.new(err_msg: msg, entry: entry, session: session),
-                      entry: entry
-                    })
+                    arr.push(ErrorCache.new(
+                      klass = Eco::API::Error.get_type(msg),
+                      klass.new(err_msg: msg, entry: entry, session: session),
+                      entry
+                    ))
                   end
                 end
               end
@@ -103,45 +82,16 @@ module Eco
           # @return [Hash] where each `key` is a `type` **error** and each value is
           #   an `Array` of `entries` that got that error
           def by_type
-            errors.group_by do |h|
-              h[:type]
+            errors.group_by do |e|
+              e.type
             end.transform_values do |arr|
-              arr.map {|h| h[:entry]}
+              arr.map {|e| e.entry}
             end
           end
           # @!endgroup
 
           # @!group Messaging methods
 
-          # Generates a `String` specifying the error for the entry `key`.
-          # @param key [Integer, Ecoportal::API::V1::Person]
-          # @return [String] the error description.
-          def str(key)
-            msg = ""
-            unless status.success?(key)
-              i        = to_index(key)
-              entry    = queue.to_a[i]
-              response = status[i]
-              msg      = "Error #{response.status}: #{response.body}\n"
-              msg     += "-- Failed to batch #{method}. Person: #{person_ref(entry)}"
-            end
-            msg
-          end
-
-          # Sorts the entries that got server error by error `type` and generates the error messages.
-          # @return [Array<String>] the errors messages.
-          def strs
-            by_type.values.flatten(1).each_with_object([]) do |query, msgs|
-              msgs.push(str(query))
-            end
-          end
-
-          def print_one(key)
-            unless status.success?(key)
-              logger.error(str(key))
-            end
-          end
-
           def message
             msgs = strs
             if msgs.length > 0
@@ -163,6 +113,29 @@ module Eco
 
           private
 
+          # Input entries that got **error** response from the _Server_.
+          # @raise [Exception] if there are elements of the final `queue` that did not get response
+          # @note discards those that did not get _response_ from the Server (so those that were not queried)
+          #   - please, observe that this can only happen if there were repeated entries in the `source_queue`
+          # @return [Array<Hash>, Array<Ecoportal::API::V1::Person>, Array<Ecoportal::API::Internal::Person>]
+          def entries
+            queue.filter.with_index do |query, i|
+              unless response = status[i]
+                msg  = "Error: query with no response. You might have duplicated entries in your queue.\n"
+                msg += "Queue length: #{queue.length}; Queue elements class: #{queue.first.class}\n"
+                msg += "Query with no response. Person: #{person_ref(query)}\n"
+                queue.map do |entry|
+                  if [:id, :external_id, :email].any? {|attr| (v = get_attr(entry, attr)) && v == get_attr(query, attr)}
+                    msg += "It could be this peson entry (idx: #{to_index(entry)}): #{person_ref(entry)}\n"
+                  end
+                end
+                raise msg
+              end
+
+              !response.success?
+            end
+          end
+
           def person_ref(entry)
             row_str = (row = get_row(entry)) ? "(row: #{row}) " : nil
             "#{row_str}(id: '#{get_attr(entry, :id)}') '#{get_attr(entry, :name)}' ('#{get_attr(entry, :external_id)}': '#{get_attr(entry, :email)}')"
@@ -185,6 +158,35 @@ module Eco
             end
           end
 
+          # Sorts the entries that got server error by error `type` and generates the error messages.
+          # @return [Array<String>] the errors messages.
+          def strs
+            by_type.values.flatten(1).each_with_object([]) do |query, msgs|
+              msgs.push(str(query))
+            end
+          end
+
+          # Generates a `String` specifying the error for the entry `key`.
+          # @param key [Integer, Ecoportal::API::V1::Person]
+          # @return [String] the error description.
+          def str(key)
+            msg = ""
+            unless status.success?(key)
+              i        = to_index(key)
+              entry    = queue.to_a[i]
+              response = status[i]
+              msg      = "Error #{response.status}: #{response.body}\n"
+              msg     += "-- Failed to batch #{method}. Person: #{person_ref(entry)}"
+            end
+            msg
+          end
+
+          def print_one(key)
+            unless status.success?(key)
+              logger.error(str(key))
+            end
+          end
+
         end
       end
     end

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

@@ -212,6 +212,13 @@ module Eco
 
           private
 
+          def subjobs_summary
+            return "" unless subjobs.count > 0
+            [].tap do |msg|
+              subjobs.map {|subjob| msg << subjob.summary}
+            end.join("\n")
+          end          
+
           def as_update(*args)
             feedback.as_update(*args)
           end
@@ -310,13 +317,6 @@ module Eco
             end
           end
 
-          def subjobs_summary
-            return "" unless subjobs.count > 0
-            [].tap do |msg|
-              subjobs.map {|subjob| msg << subjob.summary}
-            end.join("\n")
-          end
-
         end
       end
     end

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

@@ -94,7 +94,7 @@ module Eco
                 callback.call(job, job_status) if callback
               end
             end
-
+            launch(simulate: simulate) if pending?
             return status
           end
 

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

@@ -96,6 +96,7 @@ module Eco
                 self.class.counter(DELAY_BETWEEN_GROUPS) if !simulate && idx < @order.length - 1
               end
             end
+            launch(simulate: simulate) if pending?            
             return status
           end
 

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

@@ -122,7 +122,9 @@ module Eco
           def valid_index(index: nil, entry: nil)
             index ||= @hash[entry]
             unless index && index < @queue.length
-              fatal "You must provide either the index on the final 'queue' or the original entry object of the batch"
+              msg  = "You must provide either the index on the final 'queue' or the original entry object of the batch. "
+              msg += "Given, index=#{index.class}, entry:#{entry.class}"
+              fatal msg
             end
             index
           end

data/lib/eco/api/session/config/workflow.rb

@@ -195,6 +195,7 @@ module Eco
           # @yieldreturn [Eco::API::UseCases::BaseIO] the `io` input/output object carried througout all the _workflow_
           # @return [Eco::API::Session::Config::Workflow] the current stage object (to ease chainig).
           def run(key = nil, io:, &block)
+            raise "Missing BaseIO object" unless io.is_a?(Eco::API::UseCases::BaseIO)
             begin
               if key
                 io = stage(key).run(io: io, &block)

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

@@ -25,10 +25,30 @@ class Eco::API::UseCases::OozeSamples::OozeUpdateCase < Eco::API::Common::Loader
     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
-        logger.info("Got ooze '#{ooze_id}': '#{ooze.name}'")
+        new_target(ooze)
+        logger.info("Got #{object_reference(ooze)}")
       else
         logger.error("Could not get ooze '#{ooze_id}'")
         exit(1)
@@ -39,7 +59,7 @@ class Eco::API::UseCases::OozeSamples::OozeUpdateCase < Eco::API::Common::Loader
   def launch_request
     prompt_to_confirm!
 
-    apiv2.pages.update(ooze).tap do |response|
+    apiv2.pages.update(target).tap do |response|
       if response.success?
         logger.info("All went OK")
       else
@@ -59,9 +79,35 @@ class Eco::API::UseCases::OozeSamples::OozeUpdateCase < Eco::API::Common::Loader
    @apiv2 ||= session.api(version: :oozes)
   end
 
-  def patch_doc(renew: false)
-    return @patch_doc if @patch_doc && !renew
-    @patch_doc = apiv2.pages.get_body(ooze)
+  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!

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.2"
+  VERSION = "2.0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.7
 platform: ruby
 authors:
 - Oscar Segura
@@ -116,7 +116,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -126,7 +126,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.6
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.6
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'