eco-helpers 2.0.15 → 2.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ea76fb273e572c873b2f23348c54b56fd4e51cd39d9bf1109ddbc4594ba260f
-  data.tar.gz: 56d64b1eb28202f4bd18997ff8854fdd6ae36c758217796f4739012f59d4ef5c
+  metadata.gz: 669f1a3e8d49a2499b02d925386477a8e52cc633c830072420484edcf8e4919d
+  data.tar.gz: 86b36286a089bfa03d3cb17d4c17648a4dcc5f1ed07145ee81565cd19d102c90
 SHA512:
-  metadata.gz: bf49254f9b3f162f278d65f734fba3d3f683906cb1202df4d4cc4f7a90f2d663655e5168cf5bdea13d78b63d8ece32bcd22541655b001f3a9bfad429d89d2de8
-  data.tar.gz: 3dcd85969e34079aa050546e427ebe0d28cb7ec358b121f066cd603af23c9c44bb05551ce8db061f1721832981c2b74c1a46aa095c031f9ea0fb8b29b1b65310
+  metadata.gz: 0a346a01757374cc004c12b5aadadf6b3c1daebba937c8d1c0cf597608297ab825d604af3a7f70f92528e28e0f009fd482abd31eb660c4abcf9d9796f55f69db
+  data.tar.gz: f912a967dfb21cb0e455b357c9f5ca28fae4de55cbacd060fd000add64992b86168a3ed38150d1ddaf9a264245da582a49c434d62d24bc28285d82b3f9a2e693

data/CHANGELOG.md

@@ -1,12 +1,25 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.15] - 2021-04-xx
+## [2.0.16] - 2021-04-xx
 
 ### Added
-  - Use case `Eco::API::UseCases::DefaultCases::SupersHierarchy`, invokable via `-supers-hiearchy`
+  - Use case `Eco::API::UseCases::DefaultCases::SupersCyclicIdentify`, invokable via `-identify-cyclic-supers`
+  - Use case `Eco::API::UseCases::DefaultCases::AbstractPolicyGroupAbilities`, invokable via `-abstract-policygroup-abilities`
+  - Option to run `one-off` scripts, without org configurations:
+    1. `-api-key INTERNAL_API_KEY`
+    2. `-enviro [live|pre.dev]`
+    3. `-org NAME_OF_ORG`
+
 ### Changed
 ### Fixed
+
+
+## [2.0.15] - 2021-04-29
+
+### Added
+  - Use case `Eco::API::UseCases::DefaultCases::SupersHierarchy`, invokable via `-supers-hiearchy`
+### Fixed
   - `eco/cli/config/default/workflow.rb` prevent `rescue` looping
 
 ## [2.0.14] - 2021-04-15
@@ -17,7 +30,6 @@ All notable changes to this project will be documented in this file.
   - `Eco::API::Organization::PresetsFactory` added integrity validation for `person_*` abilities
   - `Eco::API::Session::Batch::Job` more debug info on erron handlers
 
-### Changed
 ### Fixed
   - `Eco::API::Error.get_type` was almost always matching `Eco::API::Error::Unclassified` -> fixed
 

data/eco-helpers.gemspec

@@ -36,5 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'aws-sdk-ses',   '>= 1.36.0', '< 2'
   spec.add_dependency 'dotenv',        '>= 2.7.6', '< 2.8'
   spec.add_dependency 'net-sftp',      '>= 3.0.0', '< 3.1'
-
+  #spec.add_dependency 'fuzzy_match'    '>= 2.1.0', '< 2.2'
 end

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

@@ -15,6 +15,7 @@ module Eco
             # Reorders as follows:
             #   1. supervisors, people with no supervisor or where their supervisor not present
             #   2. subordinates
+            # @return [Array<Entry>] `values` sorted by supervisors/subordinates
             def sort_by_supervisors(values, supervisors_first: true)
               raise "Expected non hash Enumerable. Given: #{values.class}" if values.is_a?(Hash)
               return [] unless values && values.is_a?(Enumerable)
@@ -32,6 +33,32 @@ module Eco
               roam.call(supervisors_tree(values))
             end
 
+            # Identifies all the cyclic supervisor chains
+            # @note as `supervisors_tree` will have any entry involved in a cycle at the top, it just checks all the top entries against their offspring
+            # @return [Array<Array>] the sets of entries that are cyclic
+            def identify_cyclic_chains(values)
+              raise "Expected non hash Enumerable. Given: #{values.class}" if values.is_a?(Hash)
+              return [] unless values && values.is_a?(Enumerable)
+
+              identify  = Proc.new do |top_sup, offspring, chain = [top_sup]|
+                next [] if offspring.empty?
+                offspring.each_with_object([]) do |(sup, subordinates), set|
+                  break set unless set.empty?
+                  if top_sup.supervisor_id == sup.id
+                    set.concat(chain, [sup])
+                  else
+                    set = identify.call(top_sup, subordinates, chain | [sup])
+                  end
+                end
+              end
+
+              supervisors_tree(values).each_with_object([]) do |(top_sup, offspring), sets|
+                if (set = identify.call(top_sup, offspring)) && !set.empty?
+                  sets.push(set)
+                end
+              end
+            end
+
             def tree_to_str(tree, lev: 0)
               raise "Required Hash tree structure. Given: #{tree.class}" unless tree.is_a?(Hash)
               "".tap do |str|

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

@@ -20,8 +20,8 @@ module Eco
             begin
               @dir = Eco::Data::Files::Directory.new(value)
               @dir_path = @dir.create
-            rescue
-              logger.error("could not create or make any sense of directory '#{value}'")
+            rescue Exception => e
+              logger.error("could not create or make any sense of directory '#{value}': #{e.to_s}")
             end
           end
 

data/lib/eco/api/organization/presets_factory.rb

@@ -3,6 +3,27 @@ module Eco
     module Organization
 
       class PresetsFactory
+
+        class << self
+
+          def all_abilities(hash = {})
+            Hash[abilities.each_with_object(nil).to_a].merge(hash)
+          end
+
+          def abilities_model
+            @abilities_model ||= JSON.load(File.open(ABILITIES))
+          end
+
+          def integrity_model
+            @integrity_model ||= JSON.load(File.open(INTEGRITY))
+          end
+
+          def abilities
+            @abilities ||= abilities_model.keys
+          end
+
+        end
+
         ABILITIES = File.join(__dir__, 'presets_values.json')
         INTEGRITY = File.join(__dir__, 'presets_integrity.json')
         DEFAULT_CUSTOM = 'presets_custom.json'
@@ -111,7 +132,7 @@ module Eco
         end
 
         def integrity_model
-          @integrity_model ||= JSON.load(File.open(INTEGRITY))
+          self.class.integrity_model
         end
 
         def value_exists?(ability, value)
@@ -129,7 +150,7 @@ module Eco
         end
 
         def abilities_model
-          @abilities_model ||= JSON.load(File.open(ABILITIES))
+          self.class.abilities_model
         end
 
         def policy_groups

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

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

@@ -40,6 +40,20 @@ module Eco
             self
           end
 
+          # Method to support CLI one-off API requests
+          def one_off
+            if SCR.get_arg("-api-key")
+              key    = SCR.get_arg("-api-key", with_param: true)
+              enviro = SCR.get_arg("-enviro") ? SCR.get_arg("-enviro", with_param: true) : "live"
+              host   = "#{enviro}.ecoportal.com"
+              org    = SCR.get_arg("-org")    ? SCR.get_arg("-org", with_param: true) : raise("You should specify -org NAME when using -api-key")
+              org    = org.downcase.split(/[^a-z]+/).join("_")
+              org    = org.to_sym
+              add(org, key: key, host: host)
+              return org
+            end
+          end
+
           def active_api
             self["active-api"]
           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

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

@@ -9,6 +9,7 @@ module Eco
   end
 end
 
+require_relative 'default_cases/abstract_policygroup_abilities_case.rb'
 require_relative 'default_cases/append_usergroups_case'
 require_relative 'default_cases/change_email_case'
 require_relative 'default_cases/codes_to_tags_case'
@@ -33,6 +34,7 @@ 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'

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

@@ -0,0 +1,161 @@
+class Eco::API::UseCases::DefaultCases::AbstractPolicyGroupAbilities < Eco::API::Common::Loaders::UseCase
+  name "abstract-policygroup-abilities"
+  type :export
+
+  attr_reader :session, :people, :options
+
+  def main(people, session, options, usecase)
+    @session = session; @options = options; @people = people
+
+    generate_csv!
+    exit(0)
+  end
+
+  private
+
+  def file
+    @file ||= options.dig(:output, :file) || "suggested_abilities.csv"
+  end
+
+  def generate_csv!
+    policy_groups.each_with_object({}) do |group, data|
+      data[group.id] ||= {}
+      data[group.id][:name]      = group.name
+      data[group.id][:suggested] = group_suggestions(group.id)
+      data[group.id][:percents]  = group_abilities(group.id)
+    end.yield_self do |data|
+      abilities_list = Eco::API::Organization::PresetsFactory.abilities
+      CSV.open(file, "w") do |csv|
+        csv << ["Type", "UserGroup", "ID", *abilities_list]
+        # Dump the final suggestions
+        data.each do |id, meta|
+          csv << ["Suggested", meta[:name], id, *meta[:suggested].values_at(*abilities_list)]
+        end
+        # Dump the percentaged levels of each ability
+        data.each do |id, meta|
+          analysis = meta[:percents].values_at(*abilities_list).each_with_object([]) do |levels, values|
+            values << levels.map do |level, percentil|
+              "#{level ? level : "null"} => #{percentil}"
+            end.join("\n")
+          end
+          csv << ["Analysis", meta[:name], id, *analysis]
+        end
+      end
+      puts "Generated file #{file}"
+    end
+  end
+
+  def policy_groups
+    @policy_groups ||= session.policy_groups
+  end
+
+  # Suggests 1 final set of abilities for a usergroup
+  def group_suggestions(id)
+    group_abilities(id).each_with_object({}) do |(key, levels), set|
+      data = levels.to_a.sort_by(&:last).reverse.first
+      set[key] = data ? data.shift : nil
+    end
+  end
+
+  # Cleans up each ability's levels by:
+  #   1. cutting at some minimum threshold percentage
+  #   2. directly selecting those greater than 70%
+  def group_abilities(id)
+    @group_abilities     ||= {}
+    @group_abilities[id] ||= ability_levels_percent(id).each_with_object({}) do |(ability, levels), out|
+      outstanding = nil
+      levels.select do |level, percentil|
+        outstanding ||= level if percentil >= 75
+        percentil > 15
+      end.yield_self do |filtered|
+        out[ability] =  outstanding ? filtered.slice(outstanding) : filtered
+      end
+    end
+  end
+
+  # With given the percentages of sets of abilities
+  # it abstracts the percentage of each level of each ability
+  def ability_levels_percent(id)
+    @ability_levels_percent     ||= {}
+    @ability_levels_percent[id] ||= Eco::API::Organization::PresetsFactory.abilities.each_with_object({}) do |key, out|
+      out[key] ||= {}
+      ability_sets_percent(id).each_with_object(out[key]) do |(set, percentil), levels|
+        levels[set[key]] ||= 0
+        levels[set[key]]   = (levels[set[key]] + percentil).round(2)
+      end
+    end
+  end
+
+  # Give a percentage to each set of abilities
+  def ability_sets_percent(id)
+    @ability_sets_percent     ||= {}
+    @ability_sets_percent[id] ||= scoped_relevant_raw_data(id).yield_self do |data|
+      # Transform ability sets counter to percentage
+      total     = data[:count]
+      abilities = data[:abilities]
+      data[:abilities].transform_values do |val|
+        percent(val, total)
+      end
+    end
+  end
+
+  # Get rid of data simingly irrelevant
+  def scoped_relevant_raw_data(id)
+    sp   = single_percent(id)
+    sing = single(id); mult = multiple(id)
+
+    # Scope Relevant Raw Data
+    case
+    when sp >= 80
+      sing
+    when sp < 15
+      mult
+    else # combine
+      all_abilities = sing[:abilities].keys | mult[:abilities].keys
+      data = {count: sing[:count] + mult[:count], abilities: {}}
+      all_abilities.each_with_object(data) do |abilities, merged|
+        scount = sing[:abilities][abilities] || 0
+        mcount = mult[:abilities][abilities] || 0
+        merged[:abilities][abilities] = scount + mcount
+      end
+    end
+  end
+
+  def single_percent(id)
+    percent(single(id)[:count], count(id))
+  end
+
+  def single(id)
+    groups_abilities.dig(id, :single) ||  {count: 0, abilities: {}}
+  end
+
+  def multiple(id)
+    groups_abilities.dig(id, :multiple) ||  {count: 0, abilities: {}}
+  end
+
+  def count(id)
+    groups_abilities.dig(id, :count) || 0
+  end
+
+  def groups_abilities
+    @groups_abilities ||= people.users.each_with_object({}) do |user, groups|
+      abilities = Eco::API::Organization::PresetsFactory.all_abilities(user.account.permissions_custom)
+      ids       = user.account.policy_group_ids
+      category  = ids.count > 1 ? :multiple : :single
+
+      ids.each do |id|
+        groups[id] ||= {count: 0}
+        groups[id][:count]   += 1
+        groups[id][category] ||= {count: 0, abilities: {}}
+        groups[id][category][:count] += 1
+        groups[id][category][:abilities][abilities] ||= 0
+        groups[id][category][:abilities][abilities]  += 1
+      end
+    end
+  end
+
+  def percent(num, total)
+    (100 * num.to_f / total).round(2)
+  end
+
+end

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

@@ -0,0 +1,72 @@
+class Eco::API::UseCases::DefaultCases::SupersCyclicIdentify < Eco::API::Common::Loaders::UseCase
+  name "identify-cyclic-supers"
+  type :export
+
+  attr_reader :session, :people, :options
+
+  def main(people, session, options, usecase)
+    @session = session; @options = options; @people = people
+
+    save!(cyclic_sets)
+    exit(0)
+  end
+
+  private
+
+  def cyclic_sets
+    Eco::API::Common::People::SupervisorHelpers.identify_cyclic_chains(people)
+  end
+
+  def file
+    @file ||= options.dig(:output, :file) || "cyclic_supers.txt"
+  end
+
+  def save!(data)
+    if data.empty?
+      session.logger.info("There were no cyclic supervisors identified!!")
+      return
+    end
+
+    ext  = File.extname(file).downcase.delete(".")
+
+    File.open(file, "w") do |fd|
+      if ext == "txt"
+        create_file(data, file: file, format: :txt)
+      elsif ext == "html"
+        puts "html is still not supported"
+        exit(1)
+        create_file(data, file: file, format: :html)
+      elsif ext == "json"
+        puts "json is still not supported"
+        exit(1)
+        create_file(data, file: file, format: :json)
+      end
+    end
+  end
+
+  def create_file(sets, file:, format: :txt)
+    File.open(file, "w") do |fd|
+      fd << sets_to_str(sets, format: format)
+    end
+    puts "Generated file #{file}"
+  end
+
+  def sets_to_str(sets, format: :txt)
+    raise "Required Array. Given: #{sets.class}" unless sets.is_a?(Array)
+    "".tap do |str|
+      sets.each do |set|
+        str << set_to_str(set, format: format)
+      end
+    end
+  end
+
+  def set_to_str(set, lev: 0, format: :txt)
+    raise "Required Array. Given: #{set.class}" unless set.is_a?(Array)
+    "".tap do |str|
+      entry = set.shift
+      str << "#{"  " * lev}#{(lev > 0)? "+-#{lev}- " : ""}#{entry.name} (#{entry.external_id}|#{entry.email}|#{entry.id})\n"
+      str << set_to_str(set, lev: lev + 1, format: format) unless !set || set.empty?
+    end
+  end
+
+end

data/lib/eco/cli.rb

@@ -23,16 +23,6 @@ module Eco
     def run(session:)
       io = Eco::API::UseCases::BaseIO.new(session: session, options: options)
       session.workflow(io: io).run(io: io)
-      #session.workflow(io: io) do |wf, io|
-      #  io = wf.run(:options, io: io)
-      #  io = wf.run(:load, io: io)
-      #  io = wf.run(:usecases, io: io)
-      #  io = wf.run(:launch_jobs, io: io)
-      #  io = wf.run(:post_launch, io: io)
-      #  io = wf.run(:report, io: io)
-      #  io = wf.run(:end, io: io)
-      #  io = wf.run(:close, io: io)
-      #end
     end
 
   end

data/lib/eco/cli/config/default/usecases.rb

@@ -7,6 +7,18 @@ ASSETS.cli.config do |cnf|
       options.deep_merge!(output: {file: file})
     end
 
+    desc = "Draws the Cyclic Supervisors when identified (use option -to file.ext)"
+    cases.add("-identify-cyclic-supers", :export, desc, case_name: "identify-cyclic-supers") do |people, session, options|
+      file = (SCR.get_arg("-to") && SCR.get_file("-to", required: true, should_exist: false)) || "supers_hierarchy.txt"
+      options.deep_merge!(output: {file: file})
+    end
+
+    desc = "Abstracts the Abilities that each Usergroup should probably have (use option -to file.ext)"
+    cases.add("-abstract-policygroup-abilities", :export, desc, case_name: "abstract-policygroup-abilities") do |people, session, options|
+      file = (SCR.get_arg("-to") && SCR.get_file("-to", required: true, should_exist: false)) || "suggested_abilities.txt"
+      options.deep_merge!(output: {file: file})
+    end
+
     desc = "It exports to a CSV the (filtered) people"
     cases.add("-people-to-csv", :export, desc) do |people, session, options|
       file = SCR.get_file("-people-to-csv", required: true, should_exist: false)

data/lib/eco/data/files/directory.rb

@@ -5,6 +5,29 @@ module Eco
     module Files
       class Directory
 
+        class << self
+          def create(path, includes_file: false)
+            return true if Files.file_exists?(path)
+
+            parts    = Files.split(File.expand_path(path))
+            filename = parts.pop if includes_file
+
+            return true if Files.dir_exists?(File.join(*parts))
+
+            subpath = nil
+            begin
+              parts.each do |curr|
+                subpath =  subpath ? File.join(subpath, curr) : curr
+                Dir.mkdir(subpath) unless Files.dir_exists?(subpath)
+              end
+            rescue Exception => e
+              pp e
+              return false
+            end
+            true
+          end
+        end
+
         attr_reader :dir_path
 
         def initialize(dir_path = Dir.pwd)
@@ -14,12 +37,14 @@ module Eco
         end
 
         def exists?
-          Files.dir_exists(@dir_path)
+          Files.dir_exists?(@dir_path)
         end
 
         def create
-          succeed = Directory.create(File.expand_path(@dir_path)) unless self.exists?
-          self.full_path if succeed
+          return self.full_path if self.exists?
+          if succeed = Directory.create(File.expand_path(@dir_path))
+            return self.full_path
+          end
         end
 
         def full_path
@@ -57,23 +82,6 @@ module Eco
           File.join(*args)
         end
 
-        def self.create(path, includes_file: false)
-          return true if Files.file_exists?(path)
-          parts = Files.split(File.expand_path(path))
-          filename = parts.pop if includes_file
-          return true if Files.dir_exists?(File.join(*parts))
-          subpath = nil
-          begin
-            parts.each do |curr|
-              subpath =  subpath ? File.join(subpath, curr) : curr
-              Dir.mkdir(subpath) unless Files.dir_exists?(subpath)
-            end
-          rescue Exception => e
-            pp e
-          end
-          false
-        end
-
         private
 
         def file_pattern(value)

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.15"
+  VERSION = "2.0.16"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.15
+  version: 2.0.16
 platform: ruby
 authors:
 - Oscar Segura
@@ -375,6 +375,7 @@ files:
 - lib/eco/api/usecases/base_case.rb
 - lib/eco/api/usecases/base_io.rb
 - lib/eco/api/usecases/default_cases.rb
+- lib/eco/api/usecases/default_cases/abstract_policygroup_abilities_case.rb
 - lib/eco/api/usecases/default_cases/append_usergroups_case.rb
 - lib/eco/api/usecases/default_cases/change_email_case.rb
 - lib/eco/api/usecases/default_cases/codes_to_tags_case.rb
@@ -399,6 +400,7 @@ files:
 - lib/eco/api/usecases/default_cases/restore_db_case.rb
 - lib/eco/api/usecases/default_cases/set_default_tag_case.rb
 - lib/eco/api/usecases/default_cases/set_supervisor_case.rb
+- lib/eco/api/usecases/default_cases/supers_cyclic_identify_case.rb
 - lib/eco/api/usecases/default_cases/supers_hierarchy_case.rb
 - lib/eco/api/usecases/default_cases/switch_supervisor_case.rb
 - lib/eco/api/usecases/default_cases/to_csv_case.rb