eco-helpers 1.5.13 → 1.5.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f83b4bc20ff8289dbc743531ceaf75350fefbefa687c3f88ae09325b762e1fd1
-  data.tar.gz: b6ecd929fc1494ba657755020eac2cd92bdfe1ad4b4e5beb454c2bcaea165b77
+  metadata.gz: 2627cbc4d42e91e131e891cc4248895660a62bab2c331b43ac8ad3cd28b9cdee
+  data.tar.gz: fb2c29b13a67114ce8bbfbd16b271519896c201ec58cb9fd37b48db238abb014
 SHA512:
-  metadata.gz: 0fbb3710424b72248a2abefb0a0c8682a6fa4e97c69b50af951298c867582e4e857b5db25fd0afe1ba0a6379f6ba85e751a48c1bed1b091ad0a180f1d52f73df
-  data.tar.gz: 16157a6f8f6118574bec5ca59716b9c52b860b89acab5a7d56bc720b34339de80b747543da684ddd68b23c694f0a67e6af82396f95c1b3811bcf203e7cadb7ee
+  metadata.gz: 6da008ea99e2e6e323afcfbc0be117dd56402b95be100a68d808d3b4e81537def757fb66418fc0028492ea2e12ac74def8d4c6c47a7d05589bac3814ce9e10d9
+  data.tar.gz: 78af32b3b9f4725211baf6e458db91c064f49f25814bbda7177fe61af1b453597d658f1d734e155c8ebeb863aabdd36a0b6b81a9fcd972c6d92f2911f05ac11f

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.5.14] - 2021-02-xx
+
+### Added
+  - `Eco::API::Policies::DefaultPolicies` policies that are run always (after the custom policies)
+    - `Eco::API::Policies::DefaultPolicies::UserAccess`:
+      - remove account if there's no `email`
+      - provision min user level to those with account (if no usergroup and no abilities)
+  - `Eco::API::Session#policies` which merges the default policies to be added/run after the custom policies
+  - `Eco::API::Common::Session::Logger`: add caching of logs
+    - `Eco::API::Common::Session::Logger::Cache` new class to manage cached logs
+    - `Eco::API::Common::Session::Logger::Log` new class to have a trace on logs
+  - `Eco::API::Session::Batch::Job#summary` added subjobs (error handlers) summary
+
+### Changed
+  - `Eco::API::Session::Batch::Job#launch` it will also run the default api policies before feedback and query launch
+  - `Eco::API::Common::People::PersonEntry` add error log when wrong email error is detected
+    - previously it would have crashed
+
+### Fixed
+
 ## [1.5.13] - 2021-02-01
 
 ### Added

data/lib/eco/api/common/people/person_entry.rb

@@ -170,14 +170,25 @@ module Eco
           end
 
           # Setter to fill in all the `core` properties of the `Person` that are present in the `Entry`.
-          # @note it only sets those core properties defined in the entry.
-          #  Meaning that if an core property is not present in the entry, this will not be set on the target person.
+          # @note
+          #   1. it only sets those core properties defined in the entry.
+          #     Meaning that if an core property is not present in the entry, this will not be set on the target person.
+          #   2. if there's an incorrect email exception, it blanks the email and logs a warning message
           # @param person [Ecoportal::API::V1::Person] the person we want to set the core values to.
           # @param exclude [String, Array<String>] core attributes that should not be set/changed to the person.
           def set_core(person, exclude: nil)
             scoped_attrs = @emap.core_attrs - into_a(exclude)
             @final_entry.slice(*scoped_attrs).each do |attr, value|
-              set_part(person, attr, value)
+              begin
+                set_part(person, attr, value)
+              rescue Exception => e
+                if attr == "email"
+                  logger.error(e.to_s + " - setting blank email instead.")
+                  set_part(person, attr, nil)
+                else
+                  raise
+                end
+              end
             end
           end
 
@@ -460,6 +471,7 @@ module Eco
                 obj.send("#{attr}=", value)
               end
             rescue Exception => e
+              # add more info to the error
               raise e.append_message " -- Entry #{to_s(:identify)}"
             end
           end

data/lib/eco/api/common/session/logger.rb

@@ -5,9 +5,12 @@ module Eco
         class Logger
           DEFAULT_TIMESTAMP_PATTERN = '%Y-%m-%dT%H:%M:%S'
 
+          attr_reader :cache
+
           def initialize(console_level: nil, file_level: ::Logger::DEBUG, log_file: nil, timestamp_console: false, enviro: nil)
             raise "Required Environment object (enviro:). Given: #{enviro}" if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
             @enviro = enviro
+            @cache  = Logger::Cache.new
 
             timestamp_console = fetch_timestamp_console(timestamp_console)
             @console_logger = ::Logger.new(STDOUT).tap do |_logger|
@@ -21,7 +24,9 @@ module Eco
             if log_file = fetch_log_file(log_file)
               @file_logger = ::Logger.new(log_file).tap do |_logger|
                 _logger.formatter = proc do |severity, datetime, progname, msg|
-                  "#{severity.to_s[0]}: #{datetime.strftime(DEFAULT_TIMESTAMP_PATTERN)} > #{msg}\n"
+                  "#{severity.to_s[0]}: #{datetime.strftime(DEFAULT_TIMESTAMP_PATTERN)} > #{msg}\n".tap do |formatted|
+                    cache.add(severity, datetime, msg, formatted)
+                  end
                 end
                 _logger.level = fetch_file_level(file_level)
               end
@@ -107,3 +112,6 @@ module Eco
     end
   end
 end
+
+require_relative "logger/cache"
+require_relative "logger/log"

data/lib/eco/api/common/session/logger/cache.rb

@@ -0,0 +1,91 @@
+module Eco
+  module API
+    module Common
+      module Session
+        class Logger
+          class Cache
+            LEVELS = ["UNKNOWN", "FATAL", "ERROR", "WARN", "INFO", "DEBUG"]
+
+            def initialize
+              reset
+            end
+
+            def level(level)
+              cache[to_level(level)] ||= []
+            end
+
+            def add(level, datetime, message, formatted)
+              Logger::Log.new(level, datetime, message, formatted).tap do |log|
+                self.level(level).push(log)
+              end
+            end
+
+            def cache
+              @cache ||= {}
+            end
+
+            def reset(level: nil, start_time: nil, end_time: nil)
+              where(start_time, end_time) do |cond|
+                to_levels(level).map do |lev|
+                  self.level(lev).reject(&cond)
+                end
+              end
+              self
+            end
+
+            def logs(level: nil, start_time: nil, end_time: nil)
+              where(start_time, end_time) do |cond|
+                to_levels(level).map do |lev|
+                  self.level(lev).select(&cond)
+                end.flatten
+              end.sort
+            end
+
+            private
+
+            def where(start_time, end_time)
+              tstart = to_datetime(start_time)
+              tend   = to_datetime(end_time)
+              condition = Proc.new do |log|
+                next true unless tstart || tend
+                log.after?(tstart) && log.before?(tend)
+              end
+
+              yield(condition)
+            end
+
+            def to_datetime(value)
+              return nil unless value
+              Time.parse(value)
+            end
+
+            def to_levels(value)
+              levels = [value].flatten.map {|v| to_level(v)}.compact
+              levels = levels.empty?? LEVELS : levels
+            end
+
+            def to_level(value)
+              nil_or_upcase(value).tap do |out|
+                valid_level!(out)
+              end
+            end
+
+            def valid_level!(str)
+              return true if !str
+              unless LEVELS.any? {|lev| str == lev}
+                raise "Unknown level #{str}. Should be one of #{LEVELS}"
+              end
+            end
+
+            def nil_or_upcase(value)
+              value = value.to_s.upcase if value
+              return yield(value) if block_given?
+              value
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/common/session/logger/log.rb

@@ -0,0 +1,48 @@
+module Eco
+  module API
+    module Common
+      module Session
+        class Logger
+          class Log
+
+            attr_accessor :level, :datetime, :message, :formatted
+
+            def initialize(level, datetime, message, formatted)
+              @level     = level
+              @datetime  = datetime
+              @message   = message
+              @formatted = formatted
+            end
+
+            def to_s
+              self.formatted
+            end
+
+            def <=>(other)
+              self.datetime <=> other.datetime
+            end
+
+            def before?(value)
+              return true if !value
+              datetime <= to_datetime(value)
+            end
+
+            def after?(value)
+              return true if !value
+              datetime >= to_datetime(value)
+            end
+
+            private
+
+            def to_datetime(value)
+              return value if value.is_a?(Time)
+              return nil unless value
+              Time.parse(value)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/policies.rb

@@ -36,3 +36,4 @@ module Eco
 end
 
 require_relative 'policies/policy'
+require_relative 'policies/default_policies'

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

@@ -0,0 +1,12 @@
+module Eco
+  module API
+    class Policies
+      class DefaultPolicies < Eco::API::Policies
+        autoloads_children_of "Eco::API::Common::Loaders::Policy"
+        autoload_namespace    "Eco::API::Policies::DefaultPolicies"
+      end
+    end
+  end
+end
+
+require_relative 'default_policies/99_user_access_policy'

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

@@ -0,0 +1,100 @@
+class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loaders::Policy
+  name "default-user-access"
+
+  attr_reader :session, :options
+  attr_accessor :account_removed_count
+
+  def main(people, session, options, policy, job)
+    @session = session; @options = options
+
+    self.account_removed_count = 0
+
+    people.each do |person|
+      remove_account_when_no_email!(person) if person.email.to_s.empty?
+      account.policy_group_ids = [defid]    if no_policy_group_ids?(person)
+      refresh_abilities!(person.account)
+    end
+
+    warn_account_removal!
+  end
+
+  private
+
+  def warn_account_removal!
+    if account_removed_count > 0
+      msg = "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)
+      person.account = nil
+    end
+  end
+
+  def had_account?(person)
+    return false if person.new?
+    return false if person.account_added?
+    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
+
+  end
+
+  def no_policy_group_ids?(person)
+    (account = person.account) &&  account.policy_group_ids.empty?
+  end
+
+  def no_abilities?(person)
+    person.account.permissions_custom &&
+    person.account.permissions_custom.values.all?(&:nil?)
+  end
+
+  def min_abilities
+    {
+      "files"         => "upload",
+      "data"          => nil,
+      "reports"       => nil,
+      "pages"         => "create",
+      "page_editor"   => "basic",
+      "registers"     => "view",
+      "organization"  => nil,
+      "person_core"         => "attach",
+      "person_core_edit"    => nil,
+      "person_core_create"  => nil,
+      "person_details"      => "view",
+      "person_account"      => nil
+    }
+  end
+
+  def defid
+    @defid ||= policy_groups.to_id(default_group)
+  end
+
+  def default_group
+    session.config.people.default_usergroup
+  end
+
+  def pgs
+    session.policy_groups
+  end
+
+end

data/lib/eco/api/session.rb

@@ -187,6 +187,8 @@ module Eco
       end
 
       # Does merge `Eco::API::UseCases::DefaultCases` with the custom cases.
+      # @note
+      #   - the order matters, as a default usecase can be redefined by a custom one with same name
       # @return [Eco::API::UseCases]
       def usecases
         @usecases ||= config.usecases.dup.tap do |cases|
@@ -195,6 +197,17 @@ module Eco
         end
       end
 
+      # Does merge `Eco::API::Policies::DefaultPolicies` with the custom policies.
+      # @note
+      #   - the default policies are added at the end (meaning they will run after the custom policies)
+      # @return [Eco::API::Policies]
+      def policies
+        @policies ||= config.policies.dup.tap do |policies|
+          default_policies = Eco::API::Policies::DefaultPolicies.new
+          policies.merge(default_policies)
+        end
+      end
+
       # Set of helpers to simplify your code
       # @see Eco::API::MicroCases
       # @return [Eco::API::MicroCases]

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

@@ -71,12 +71,6 @@ module Eco
             @subjobs ||= Eco::API::Session::Batch::Jobs.new(enviro, name: "childs-of:#{self.name}")
           end
 
-          def subjobs_add(name = "ad-hoc:job-from:#{self.name}", usecase: self.usecase, &block)
-            dup(name, usecase: usecase).tap do |subjob|
-              subjobs.add(subjob, &block)
-            end
-          end
-
           # @return [Boolean] `true` if the current batch job is a result of an error_handler
           def error_handler?
             usecase? && usecase.is_a?(Eco::API::Error::Handler)
@@ -211,6 +205,7 @@ module Eco
                 end
 
                 msg << status.errors.message unless !status
+                msg << subjobs_summary
               end
             end.join("\n")
           end
@@ -238,7 +233,7 @@ module Eco
           # Applies the changes introduced by api policies
           def apply_policies(pre_queue)
             people(pre_queue).tap do |entries|
-              policies = session.config.policies
+              policies = session.policies
               unless policies.empty? || options.dig(:skip, :api_policies)
                 policies.launch(people: entries, session: session, options: options, job: self)
               end
@@ -307,6 +302,21 @@ module Eco
             file_manager.save_json(requests, file, :timestamp)
           end
 
+          # Adds a job tied to the current job
+          # Used with error handlers that need their own job to run
+          def subjobs_add(name = "ad-hoc:job-from:#{self.name}", usecase: self.usecase, &block)
+            dup(name, usecase: usecase).tap do |subjob|
+              subjobs.add(subjob, &block)
+            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