eco-helpers 2.0.13 → 2.0.18

data/lib/eco/api/organization/presets_integrity.json

@@ -0,0 +1,58 @@
+{
+  "person_core_create": [
+    { "value": "create", "conditions": {
+        "at_least": {"person_core": "view_people_manager"}
+      }
+    }
+  ],
+  "person_core_edit": [
+    { "value": "edit", "conditions": {
+        "at_least": {"person_core": "view_people_manager"}
+      }
+    }
+  ],
+  "person_details": [
+    { "value": "view", "conditions": {
+        "at_least": {"person_core": "attach"}
+      }
+    },
+    { "value": "edit_public", "conditions": {
+        "one_of": {
+          "person_core_edit":   "edit",
+          "person_core_create": "create"
+        }
+      }
+    },
+    { "value": "view_private", "conditions": {
+        "at_least": {"person_core": "attach" }
+      }
+    },
+    { "value": "edit_private", "conditions": {
+        "one_of": {
+          "person_core_edit":   "edit",
+          "person_core_create": "create"
+        }
+      }
+    }
+  ],
+  "person_account": [
+    { "value": "view", "conditions": {
+        "at_least": {"person_core": "attach" }
+      }
+    },
+    { "value": "create", "conditions": {
+        "at_least": {"person_core_create": "create"}
+      }
+    },
+    { "value": "edit", "conditions": {
+        "at_least": {"person_core_edit": "edit"}
+      }
+    }
+  ],
+  "person_abilities": [
+    { "value": "view", "conditions": {
+        "at_least": {"person_core_edit": "edit"}
+      }
+    }
+  ]
+}

data/lib/eco/api/organization/presets_values.json

@@ -2,14 +2,15 @@
   "files": [null, "download", "upload", "browse", "administrate"],
   "data": [null, "view", "update", "administrate", "implement"],
   "reports": [null, "view", "edit", "administrate"],
+  "pages": [null, "view", "update", "create", "administrate"],
+  "page_editor": [null, "basic", "intermediate", "advanced", "implement"],
+  "registers": [null, "view", "dashboard", "administrate", "implement"],
   "tasks": [null, "reassign_self", "reassign", "administrate"],
   "organization": [null, "view", "administrate", "implement"],
   "person_core": [null, "attach", "view_people_manager", "dashboard"],
   "person_core_create": [null, "create"],
   "person_core_edit": [null, "edit"],
-  "person_account": [null, "view", "create", "edit"],
   "person_details": [null, "view", "edit_public", "view_private", "edit_private"],
-  "pages": [null, "view", "update", "create", "administrate"],
-  "page_editor": [null, "basic", "intermediate", "advanced", "implement"],
-  "registers": [null, "view", "dashboard", "administrate", "implement"]
+  "person_account": [null, "view", "create", "edit"],
+  "person_abilities": [null, "view", "edit"]
 }

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

@@ -12,7 +12,6 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
     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)
     end
 
     warn_account_removal!
@@ -40,39 +39,10 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
     return !!person.original_doc["account"]
   end
 
-  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)
     (account = person.account) &&  account.policy_group_ids.empty?
   end
 
-  def no_abilities?(person)
-    return true unless account = person.account
-    account.permissions_custom && 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]).compact
   end

data/lib/eco/api/session.rb

@@ -61,28 +61,9 @@ module Eco
         self
       end
 
-      # Builds the presets using the usergroup ids of the input.
-      # @note for each flag/ability it will take the highest among those mapped for the present usergroups.
-      # @param input [Ecoportal::API::Internal::Person, Array<String>] the array should be of usegroup names or ids.
-      # @return [Hash] with custom presets.
-      def new_preset(input)
-        case input
-        when Ecoportal::API::Internal::Person
-          presets_factory.new(*input&.account&.policy_group_ids)
-        when Array
-          presets_factory.new(*input)
-        else
-          presets_factory.new(input)
-        end
-      end
-
       # Helper to state the abilities that a person should have with given their usergroups
       def presets_factory
-        @presets_factory ||= Eco::API::Organization::PresetsFactory.new({
-          presets_custom: file_manager.dir.file(config.people.presets_custom, should_exist: true),
-          presets_map:    file_manager.dir.file(config.people.presets_map,    should_exist: true),
-          enviro:         enviro
-        })
+        @presets_factory ||= Eco::API::Organization::PresetsFactory.new(enviro: enviro)
       end
 
       # Helper to obtain a EntryFactory

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

@@ -114,14 +114,16 @@ module Eco
               logger.info(msg) unless silent
 
               start_slice = Time.now
-              people_api.batch do |batch|
-                slice.each do |person|
-                  batch.public_send(method, person) do |response|
-                    faltal("Request with no response") unless !!response
-                    status[person] = response
+              offer_retry_on(Ecoportal::API::Errors::TimeOut) do
+                people_api.batch do |batch|
+                  slice.each do |person|
+                    batch.public_send(method, person) do |response|
+                      faltal("Request with no response") unless !!response
+                      status[person] = response
+                    end
                   end
-                end
-              end # next batch
+                end # end batch
+              end
 
               iteration  += 1
               done       += slice.length
@@ -129,6 +131,20 @@ module Eco
           end
         end
 
+        def offer_retry_on(error_type, retries_left = 3, &block)
+          begin
+            block.call
+          rescue error_type => e
+            raise unless retries_left > 0
+            print "Batch TimeOut. You have #{retries_left} retries left. Do you want to retry (y/N)? "
+            if (res = STDIN.gets.chomp) && res[0].downcase == "y"
+              offer_retry_on(error_type, retries_left - 1, &block)
+            else
+              raise
+            end
+          end
+        end
+
         def str_stats(start, count)
           now     = Time.now
           secs    = (now - start).round(3)

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

@@ -288,10 +288,13 @@ module Eco
               handlers = session.config.error_handlers
               if status.errors.any? && !handlers.empty? && !error_handler?
                 err_types = status.errors.by_type
+                logger.debug("(#{self.name}) got these error types: #{err_types.keys}")
                 handlers.each do |handler|
                   if entries = err_types[handler.name]
                     handler_job = subjobs_add("#{self.name} => #{handler.name}", usecase: handler)
+                    logger.debug("Running error handler #{handler.name}")
                     handler.launch(people: people(entries), session: session, options: options, job: handler_job)
+                    logger.debug("Launching job of error handler: #{handler_job.name}")
                     handler_job.launch(simulate: simulate)
                   end
                 end

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

@@ -159,6 +159,8 @@ module Eco
         end
 
         def working_directory(mode: nil)
+          return files.working_directory if apis.active_api&.one_off?
+
           unless mode
             wd = files.working_directory
             return wd unless wd.to_s.strip.empty?
@@ -183,12 +185,21 @@ module Eco
         end
 
         def require(file = nil, match: nil)
-          if match
-            file_manager.dir.dir_files(pattern: match).each do |file|
-              require_relative File.expand_path(file)
+          begin
+            if match
+              file_manager.dir.dir_files(pattern: match).each do |file|
+                require_relative File.expand_path(file)
+              end
+            else
+              target = File.expand_path(file_manager.dir.file(file))
+              require_relative target
+            end
+          rescue LoadError => e
+            if apis.active_api.one_off?
+              pp e.to_s
+            else
+              raise
             end
-          else
-            require_relative "#{File.expand_path(file_manager.dir.file(file))}"
           end
         end
         # @!endgroup
@@ -286,16 +297,6 @@ module Eco
           people.default_schema = name
         end
 
-        # Specify the file with the account custom abilities presets
-        def presets_custom=(file)
-          people.presets_custom = file
-        end
-
-        # Specify the file with the usergroup to custom presets mapping
-        def presets_map=(file)
-          people.presets_map = file
-        end
-
         # @see Eco::API::Session::Config::People
         # @param (see Eco::API::Session::Config::People)
         # @return [Eco::API::Common::People::PersonParser] parser/serializer for the defined `format`.

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

@@ -83,6 +83,10 @@ module Eco
             self["name"]
           end
 
+          def one_off?
+            name.is_a?(Symbol)
+          end
+
           def key
             self["key"]
           end

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

@@ -82,6 +82,86 @@ module Eco
             self["user_key"]
           end
 
+          # Method to support CLI one-off API requests
+          def one_off
+            if one_off?
+              add(one_off_org, key: one_off_key, host: "#{one_off_enviro}.ecoportal.com")
+              return one_off_org
+            end
+          end
+
+          private
+
+          def one_off?
+            @is_one_off ||= SCR.get_arg("-api-key") || SCR.get_arg("-one-off")
+          end
+
+          def one_off_key
+            return @one_off_key if instance_variable_defined?(:@one_off_key)
+            if one_off?
+              Dotenv.load("./.env_one_off")
+              SCR.get_arg("-api-key", with_param: true).yield_self do |key|
+                 one_off_key_env(key)
+              end
+            end
+          end
+
+          def one_off_key_env(key)
+            if one_off?
+              if key
+                env_file_set_var("./.env_one_off", one_off_key_env_var, key)
+                key
+              else
+                Dotenv.load("./.env_one_off")
+                ENV[one_off_key_env_var].tap do |k|
+                  raise "At least the first time, you should provide the -api-key" unless k
+                end
+              end
+            end
+          end
+
+          def one_off_key_env_var
+            @one_off_key_env_var ||= "#{one_off_org}_KEY"
+          end
+
+          def one_off_org
+            return @one_off_org if instance_variable_defined?(:@one_off_org)
+            unless org = SCR.get_arg("-org", with_param: true)
+              raise("You should specify -org NAME when using -api-key or -one-off")
+            end
+            @one_off_org  ||= "#{org.downcase.split(/[^a-z]+/).join("_")}_#{one_off_enviro.gsub(".", "_")}".to_sym
+          end
+
+          def one_off_enviro
+            return @one_off_enviro if instance_variable_defined?(:@one_off_enviro)
+            enviro = SCR.get_arg("-enviro") ? SCR.get_arg("-enviro", with_param: true) : "live"
+            @one_off_enviro ||= enviro.downcase
+          end
+
+          def env_file_set_var(file, var, value)
+            begin
+              pattern = /"#{var}=(?<value>[^ \r\n]+)"/
+              File.open(file, "w+") do |fd|
+                found = false
+                fd.each_line do |line|
+                  if match = line.match(pattern)
+                    found = true
+                    #  IO::SEEK_CUR => Seeks to _amount_ plus current position
+                    fd.seek(-(line.length + 1), IO::SEEK_CUR)
+                    fd.write line.gsub(match[:value], value)
+                  end
+                end
+
+                fd << "#{var}=#{value}" unless found
+              end
+            rescue StandardError => e
+              puts "#{e}"
+              return false
+            end
+            return true
+          end
+
+
         end
       end
     end

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

@@ -14,6 +14,13 @@ module Eco
           end
 
           def working_directory
+            if config.apis.active_api&.one_off?
+              one_off_dir = File.join("one_off", config.apis.active_name.to_s)
+              unless full_path = Eco::Data::Files::Directory.new(one_off_dir).create
+                raise "Could not create the folder '#{full_path}'"
+              end
+              self["dir"] = one_off_dir
+            end
             self["dir"]
           end
 

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

@@ -9,7 +9,7 @@ module Eco
           end
 
           def cache
-            self["cache"]
+            self["cache"] ||= "cache/people.json"
           end
 
           def partial_cache
@@ -35,7 +35,7 @@ module Eco
           end
 
           def requests_folder
-            self["requests_folder"]
+            self["requests_folder"] ||= "requests"
           end
 
           # people to exclude from update feeds
@@ -86,23 +86,7 @@ module Eco
           def default_schema?
             !!self["default_schema"]
           end
-
-          def presets_custom=(file)
-            self["presets_custom"] = file
-          end
-
-          def presets_custom
-            self["presets_custom"]
-          end
-
-          def presets_map=(file)
-            self["presets_map"] = file
-          end
-
-          def presets_map
-            self["presets_map"]
-          end
-
+          
           # @return [Hash] with defined pairs format `key` and Person parsers.
           def parsers
             self["parsers"] ||= {}

data/lib/eco/api/usecases/default_cases.rb

@@ -9,6 +9,8 @@ module Eco
   end
 end
 
+require_relative 'default_cases/abstract_policygroup_abilities_case.rb'
+require_relative 'default_cases/analyse_people_case'
 require_relative 'default_cases/append_usergroups_case'
 require_relative 'default_cases/change_email_case'
 require_relative 'default_cases/codes_to_tags_case'
@@ -22,7 +24,6 @@ require_relative 'default_cases/hris_case'
 require_relative 'default_cases/new_id_case'
 require_relative 'default_cases/new_email_case'
 require_relative 'default_cases/org_data_convert_case'
-require_relative 'default_cases/refresh_abilities_case'
 require_relative 'default_cases/refresh_case'
 require_relative 'default_cases/reinvite_trans_case'
 require_relative 'default_cases/reinvite_sync_case'
@@ -32,6 +33,8 @@ require_relative 'default_cases/reset_landing_page_case'
 require_relative 'default_cases/restore_db_case'
 require_relative 'default_cases/set_default_tag_case'
 require_relative 'default_cases/set_supervisor_case'
+require_relative 'default_cases/supers_hierarchy_case'
+require_relative 'default_cases/supers_cyclic_identify_case'
 require_relative 'default_cases/switch_supervisor_case'
 require_relative 'default_cases/to_csv_case'
 require_relative 'default_cases/to_csv_detailed_case'