eco-helpers 1.5.0 → 1.5.5

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

@@ -26,17 +26,24 @@ module Eco
             end
           end
 
-          def add(name, key:, host:, version: :internal, mode: :local)
+          def add(name, key:, host:, version: :internal, mode: :local, user_key: nil, external_key: nil)
             apis[name] = Session::Config::Api.new(
-              key: key,
-              host: host,
-              version: version,
-              mode: mode,
-              root: self
+              name,
+              key:      key,
+              host:     host,
+              version:  version,
+              mode:     mode,
+              root:     self,
+              user_key: user_key,
+              external_key: external_key
             )
             self
           end
 
+          def active_api
+            self["active-api"]
+          end
+
           def active_name=(name)
             raise "'#{name}' Api environment not defined" if !apis[name]
             self["active-name"] = name
@@ -53,34 +60,26 @@ module Eco
             active_name
           end
 
-          def active_api
-            self["active-api"]
-          end
-
           def service_up?
-            api_klass = (active_api.version == :external)? Ecoportal::API::External : Ecoportal::API::Internal
-            @api_test ||= api_klass.new("foobar", host: active_api.host, logger: ::Logger.new(IO::NULL))
+            @api_test ||= Session::Config::Api.api_class(active_api.version).new("foobar", host: active_api.host, logger: ::Logger.new(IO::NULL))
             status = @api_test.client.get("/policy_groups").status
             # 401 Unauthorized "Permission denied. API key may be invalid."
             status == 401
           end
 
-          def api(logger = ::Logger.new(IO::NULL), force_new: false)
-            key     = active_api.key
-            host    = active_api.host
-            mode    = active_api.mode
-            version = active_api.version
-            return @api if (!force_new) && @api && key == @key && host == @host && @mode == mode && version == @version
-
-            api_klass = (version == :external)? Ecoportal::API::External : Ecoportal::API::Internal
+          def api(logger = ::Logger.new(IO::NULL), version: nil)
+            unless active_api
+              raise "There's no 'active_api'. Use apis.active_name='api_enviro_name' to set the active api"
+            end
+            active_api.api(version: version, logger: logger)
+          end
 
-            @api  = api_klass.new(key, host: host, logger: logger)
-            @key  = key; @host = host; @mode = mode; @version = version
-            @api
+          def default_user_key=(key)
+            self["user_key"] = key
           end
 
-          def new_api(logger = ::Logger.new(IO::NULL))
-            api(logger, force_new: true)
+          def default_user_key
+            self["user_key"]
           end
 
         end

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

@@ -37,11 +37,11 @@ module Eco
           end
 
           def log_connection=(value)
-            self["log_connection"] = value
+            self["log_connection"] = !!value
           end
 
           def log_connection?
-            !!self["log_connection"]
+            self["log_connection"]
           end
 
         end

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

@@ -18,7 +18,7 @@ module Eco
             count == 0
           end
 
-          def each(params: {}, &block)
+          def each(&block)
             return to_enum(:each) unless block
             items.each(&block)
           end

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

@@ -7,9 +7,10 @@ module Eco
 
           WORKFLOW_MODEL = [
             :options,
-            {load: [:input, {people: [:get, :filter]}, :filter]},
+            {load: [{input: [:get, :filter]}, {people: [:get, :filter]}, :filter]},
             :usecases, :launch_jobs,
             {post_launch: [:usecases, :launch_jobs]},
+            :report,
             :end, :close
           ]
 
@@ -49,7 +50,7 @@ module Eco
 
             @pending  = true
             # moments
-            @on   = nil
+            @on       = nil
             @before   = []
             @after    = []
           end
@@ -104,7 +105,7 @@ module Eco
           # @yield [stage_workflow, io] the behaviour of the target stage `key` when the _workflow_ reaches it
           # @yieldparam stage_workflow [Eco::API::Session::Config::Workflow] the _target stage_  referred by `key`
           # @yieldparam io [Eco::API::UseCases::BaseIO] the input/output object carried througout all the _workflow_
-          # @yieldreturn io [Eco::API::UseCases::BaseIO] the input/output object carried througout all the _workflow_
+          # @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 on(key = nil, &block)
             raise "A block should be given." unless block
@@ -120,7 +121,7 @@ module Eco
           # @yield [exception, io] the `callback` to do something with an `Exception` raised within this _workflow_ stage
           # @yieldparam exception [Exception] the exception object that was raised
           # @yieldparam io [Eco::API::UseCases::BaseIO] the input/output object carried througout all the _workflow_
-          # @yieldreturn io [Eco::API::UseCases::BaseIO] the input/output object carried througout all the _workflow_
+          # @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 rescue(&block)
             return @rescue unless block
@@ -138,7 +139,7 @@ module Eco
           # @yield [stage_workflow, io] one of the things to do **before** the `on` _callback_ of the (sub)stage `key` is actually `run`
           # @yieldparam stage_workflow [Eco::API::Session::Config::Workflow] the _target stage_  referred by `key`
           # @yieldparam io [Eco::API::UseCases::BaseIO] the input/output object carried througout all the _workflow_
-          # @yieldreturn io [Eco::API::UseCases::BaseIO] the input/output object carried througout all the _workflow_
+          # @yieldreturn [Eco::API::UseCases::BaseIO] `io` the input/output object carried througout all the _workflow_
           # @return [Eco::API::Session::Config::Workflow] the current stage object (to ease chainig).
           def before(key = nil, &block)
             raise "A block should be given." unless block
@@ -160,7 +161,7 @@ module Eco
           # @yield [stage_workflow, io] one of the things to do **after** the `on` _callback_ of the (sub)stage `key` is actually `run`
           # @yieldparam stage_workflow [Eco::API::Session::Config::Workflow] the _target stage_  referred by `key`
           # @yieldparam io [Eco::API::UseCases::BaseIO] the input/output object carried througout all the _workflow_
-          # @yieldreturn io [Eco::API::UseCases::BaseIO] the input/output object carried througout all the _workflow_
+          # @yieldreturn [Eco::API::UseCases::BaseIO] `io` the input/output object carried througout all the _workflow_
           # @return [Eco::API::Session::Config::Workflow] the current stage object (to ease chainig).
           def after(key = nil, &block)
             raise "A block should be given." unless block
@@ -191,7 +192,7 @@ module Eco
           # @yield [stage_workflow, io] if a `block` is provided, see `note`
           # @yieldparam stage_workflow [Eco::API::Session::Config::Workflow] the _target stage_ referred by `key`
           # @yieldparam io [Eco::API::UseCases::BaseIO] the input/output object carried througout all the _workflow_
-          # @yieldreturn io [Eco::API::UseCases::BaseIO] the input/output object carried througout all the _workflow_
+          # @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)
             begin

data/lib/eco/api/usecases.rb

@@ -1,6 +1,7 @@
 module Eco
   module API
     class UseCases
+
       class UnkownCase < Exception
         def initialize(msg = nil, case_name: nil, type: nil)
           msg ||= "Unkown case"
@@ -19,8 +20,12 @@ module Eco
 
       end
 
+      extend  Eco::API::Common::ClassAutoLoader
       include Enumerable
 
+      autoloads_children_of "Eco::API::Common::Loaders::UseCase"
+      autoload_namespace_ignore "Eco::API"
+
       def initialize()
         @usecases      = {}
         @cache_init    = false
@@ -35,38 +40,61 @@ module Eco
         count == 0
       end
 
-      def each(params: {}, &block)
+      def each(&block)
         return to_enum(:each) unless block
         items.each(&block)
       end
 
       def items
-        @usecases.values
+        to_h.values
+      end
+
+      def defined?(name, type: nil)
+        return to_h.key?(key(name, type)) if type
+        name?(name)
+      end
+
+      def name?(name)
+        !!by_name[name]
+      end
+
+      # @return [Eco::API::UseCases::UseCase] the `name` usecase of type `type` with the defined `block`.
+      def define(name, type:, &block)
+        Eco::API::UseCases::UseCase.new(name, type: type, root: self, &block).tap do |usecase|
+          add(usecase)
+        end
       end
 
+      # Adds `usecase` to the _Collection_. Before it tries to auto-load pending classes of `auto_loaded_class`.
+      # @param usecase [Eco::API::UseCases::UseCase] the usecase to be added.
       def add(usecase)
         raise "Expected Eco::API::UseCases::UseCase object. Given: #{usecase}" if !usecase || !usecase.is_a?(Eco::API::UseCases::UseCase)
         name = usecase.name
         type = usecase.type
         puts "Warning: overriding '#{type.to_s}' case #{name}" if self.defined?(name, type: type)
+        to_h[key(name, type)] = usecase
         @cache_init = false
-        @usecases[key(name, type)] = usecase
         usecase
       end
 
-      def define(name, type:, &block)
-        Eco::API::UseCases::UseCase.new(name, type: type, root: self, &block).tap do |usecase|
-          add(usecase)
-        end
+      # @return [Eco::API::UseCases] a copy of instance object of `self`.
+      def dup
+        self.class.new.merge(self)
       end
 
-      def defined?(name, type: nil)
-        return @usecases.key?(key(name, type)) if type
-        name?(name)
-      end
+      # Merges cases overriding self for exisint parsers
+      # @param cases [Eco::API::UseCases] the source set of cases to be merged.
+      # @return [Eco::API::UseCases] `self`.
+      def merge(cases)
+        return self if !cases
+        raise "Expected a Eco::API::UseCases object. Given #{cases.class}" if !cases.is_a?(Eco::API::UseCases)
 
-      def name?(name)
-        !!by_name[name]
+        to_h.merge!(cases.to_h).transform_values do |usecase|
+          usecase.root = self
+        end
+
+        @cache_init = false
+        self
       end
 
       def names
@@ -79,7 +107,7 @@ module Eco
       end
 
       def case(name, type: nil)
-        if type && target_case = @usecases[key(name, type)]
+        if type && target_case = to_h[key(name, type)]
           return target_case
         elsif type
           raise UseCases::UnkownCase.new(case_name: name, type: type)
@@ -89,25 +117,10 @@ module Eco
         cases.first
       end
 
-      # merges cases overriding self for exisint parsers
-      def merge(cases)
-        return self if !cases
-        raise "Expected a Eco::API::UseCases object. Given #{cases.class}" if !cases.is_a?(Eco::API::UseCases)
-        cases_hash = cases.to_h
-
-        @usecases.merge!(cases_hash)
-
-        cases_hash.transform_values do |usecase|
-          usecase.root = self
-        end
-
-        @cache_init = false
-        self
-      end
-
       protected
 
       def to_h
+        init_caches
         @usecases
       end
 
@@ -119,9 +132,11 @@ module Eco
       end
 
       def init_caches
-        return true if @cache_init
-        @cache_init = true
+        # first, make sure it loads pending `:custom_children` children to be loaded
+        re_init = self.class.autoload_children(self)
+        return true if @cache_init && !re_init
         @by_name = @usecases.values.group_by { |usecase| usecase.name }
+        @cache_init = true
       end
 
       def key(name, type)
@@ -140,7 +155,6 @@ module Eco
 end
 
 require_relative 'usecases/base_case'
-require_relative 'usecases/default_case'
 require_relative 'usecases/use_case'
 require_relative 'usecases/use_case_chain'
 require_relative 'usecases/base_io'

data/lib/eco/api/usecases/backup/append_usergroups_case.rb

@@ -0,0 +1,36 @@
+module Eco
+  module API
+    class UseCases
+      class DefaultCases
+        class AppendUsergroupsCase < DefaultCase
+
+          def process
+            @cases.define("append-usergroups", type: :sync) do |entries, people, session, options, usecase|
+              update   = session.job_group("main").new("update", usecase: usecase, type: :update, sets: [:core, :details, :account])
+
+              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
+              pgs = session.policy_groups
+
+              entries.each.with_index do |entry, i|
+                if person = people.find(entry, strict: strict_search)
+                  if person.account
+                    ini_pg_ids = person.account&.policy_group_ids || []
+                    add        = entry.internal_entry["policy_group_ids"].to_s.split("|").compact
+                    person.account.policy_group_ids = (ini_pg_ids | add).uniq
+
+                    person.account.permissions_custom = session.new_preset(person) unless options.dig(:exclude, :abilities)
+                    update.add(person)
+                  end
+                else
+                  session.logger.error("This person does not exist: #{entry.to_s(:identify)}")
+                end
+              end
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/usecases/backup/create_case.rb

@@ -0,0 +1,104 @@
+module Eco
+  module API
+    class UseCases
+      class DefaultCases
+        class CreateCase < DefaultCase
+
+          def process
+            @cases.define("create", type: :sync) do |entries, people, session, options, usecase|
+              creation = session.job_group("main").new("create", usecase: usecase, type: :create, sets: [:core, :details, :account])
+              supers   = session.job_group("post").new("supers", usecase: usecase, type: :update, sets: :core)
+
+              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
+              pgs = session.policy_groups
+
+              if session.config.people.default_usergroup?
+                def_id  = pgs.to_id(session.config.people.default_usergroup)
+              end
+
+              entries.each.with_index do |entry, i|
+                if person = people.find(entry, strict: strict_search)
+                  session.logger.error("This person (id: '#{person.id}') already exists: #{entry.to_s(:identify)}")
+                else
+                  person = session.new_person
+                  core_excluded = ["supervisor_id"]
+
+                  ini_tags   = person.filter_tags || []
+                  entry.set_core(person, exclude: core_excluded)
+
+                  if session.tagtree
+                    person.filter_tags = session.tagtree.user_tags(
+                      initial:          ini_tags,
+                      final:            person.filter_tags,
+                      preserve_custom:  true,
+                      add_custom:       true
+                    )
+                  end
+
+                  entry.set_details(person) unless options.dig(:exclude, :details)
+
+                  unless options.dig(:exclude, :account)
+                    add_account = !person.account
+                    ini_pg_ids  = person.account&.policy_group_ids || []
+
+                    account_excluded = []
+                    account_excluded.push("policy_group_ids") if options.dig(:exclude, :policy_groups) && !create
+
+                    entry.set_account(person, exclude: account_excluded)
+
+                    person.account&.send_invites = options[:send_invites] if options.key?(:send_invites)
+
+                    unless options.dig(:exclude, :policy_groups) && !create
+                      end_pg_ids = person.account.policy_group_ids || []
+
+                      if add_account && def_id && !entry.policy_group_ids?
+                        # on account creation, if missing policy_group_ids column in the input
+                        # use default_usergroup, if it's defined
+                        end_pg_ids = [def_id]
+                      end
+
+                      # avoid false updates by preserving the original order
+                      person.account.policy_group_ids   = pgs.user_pg_ids(
+                        initial:         ini_pg_ids,
+                        final:           end_pg_ids
+                      )
+                    end
+
+                    person.account.permissions_custom = session.new_preset(person)
+
+                    if session.tagtree
+                      person.account.default_tag = session.tagtree.default_tag(*person.filter_tags)
+                    else
+                      tags = person.filter_tags || []
+                      person.account.default_tag = tags.first unless tags.length > 1
+                    end
+                  end
+
+                  creation.add(person)
+
+                  # set supervisor
+                  unless options.dig(:exclude, :core) || options.dig(:exclude, :supervisor)
+                    if !(sup_id = entry.supervisor_id)
+                      person.supervisor_id = nil
+                    else
+                      if supervisor = people.person(id: sup_id, external_id: sup_id, email: sup_id)
+                        person.supervisor_id = supervisor.id
+                      else
+                        # delay setting supervisor if does not exit
+                        supers.add(person) do |person|
+                          person.supervisor_id = sup_id
+                        end
+                      end
+                    end
+                  end
+
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end