eco-helpers 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad5941e8792705047cf6dbd46515023c9bda2285
-  data.tar.gz: b1b3ef9fa046781f791170f2a4e872ef79862efe
+  metadata.gz: 4a9a891a431684fe13200bdd2b55d92c418fdd09
+  data.tar.gz: badc9350ac7b4f8b1061a7f7ab25393af5bace7c
 SHA512:
-  metadata.gz: b05481b93f00fe18b0d8721ec2c1e11e25e85bda934042458e948217bb8e52a5efe2ae53464525bd95baffcb003f749361653bb0273edd8ae4ea80ea6b4a1c64
-  data.tar.gz: e26cc0b7607a2c7197c1e528a914ca9ea2414688205d21421c582d81317a54c6cc76c454646d88b865f287ebe389bd44e85cf0929b09036e8859183bc5856add
+  metadata.gz: 0df330e81d17f875c120dcd0abc87f142a478e91b186cf4f70a4634ce513ad69a6d16fd4e5eea9da17ef7b366c84b129758d38a001627134f488ba35181bfdc2
+  data.tar.gz: 7154d3081842a3efc237bdbd80e8a5fc310a079eee2e71861456b5e47fc64c6fedaa15e880d5a97a10be2fc50059896fc328e630702976ee9672c87d5c2d266a

data/eco-helpers.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec", "~> 3", ">= 3.8"
+  s.add_development_dependency "yard", "~> 0.9", ">= 0.9.18"
+  s.add_development_dependency "redcarpet", "~> 3.4", ">= 3.4.0"
 
   s.add_dependency 'ecoportal-api', '~> 0.3', '>= 0.3.6'
   s.add_dependency 'faker',         '~> 1',   '>= 1.9'

data/lib/eco/api/organization.rb

@@ -8,6 +8,5 @@ end
 require_relative 'organization/tag_tree'
 require_relative 'organization/presets'
 require_relative 'organization/preferences'
-require_relative 'organization/account'
 require_relative 'organization/people'
 require_relative 'organization/policy_groups'

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

@@ -9,10 +9,8 @@ module Eco
 
         alias_method :people, :to_a
 
-        include Common::People
-
-        def initialize(people = [], klass: INTERNAL::Person, factory: nil)
-          @klass = INTERNAL::Person unless klass == EXTERNAL::Person
+        def initialize(people = [], klass: Ecoportal::API::Internal::Person, factory: nil)
+          @klass = Ecoportal::API::Internal::Person unless klass == Ecoportal::API::V1::Person
           super(people, klass: @klass)
           @caches_init = false
         end

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

@@ -2,10 +2,21 @@ module Eco
   module API
     module Organization
 
+      # Provides helpers to deal with tagtrees.
       class TagTree
         attr_reader :tag, :nodes
         attr_reader :depth, :path
 
+        # @example Node format:
+        #     {"tag": "NODE NAME", "nodes": subtree}
+        # @example Tree/subtree format:
+        #    [[Node], ...]
+        # @example Input format example:
+        #    tree = [{"tag" => "AUSTRALIA", "nodes" => [
+        #        {"tag" => "SYNDEY", "nodes" => []}
+        #    ]}]
+        #    tree = TagTree.new(tree.to_json)
+        # @param tagtree [String] representation of the tagtree in json.
         def initialize(tagtree = [], depth: -1, path: [], enviro: nil)
           case tagtree
           when String
@@ -29,29 +40,68 @@ module Eco
           init_hashes
         end
 
+        # List of tag nodes of the entire subtree.
+        # @return [Array<String>]
         def tags
           @hash_tags.keys
         end
 
+        # Verifies if a tag exists in the tree.
+        # @param key [String] tag to verify.
+        # @return [Boolean]
         def tag?(key)
           @hash_tags.key?(key.upcase)
         end
 
+        # Finds a subtree node.
+        # @param key [String] parent node of subtree.
+        # @return [TagTree, nil] if the tag `key` is a node, returns that node.
         def get_node(key)
           return nil unless tag?(key)
           @hash_tags[key.upcase]
         end
 
+        # Filters tags out that do not belong to the tree
+        # @param list [Array<String>] source tags.
+        # @return [Array<String>]
         def filter_tags(list)
           return [] unless list && list.is_a?(Array)
           list.select {|str| tag?(str)}
         end
 
+        # Finds the path from a node `key` to the its root node in the tree.
+        #  If `key` is not specified, returns the path from current node to root.
+        # @note the `path` is not relative to the subtree, but absolute to the entire tree.
+        # @param key [String] tag to find the path to.
+        # @return [Array<String>]
         def path(key = nil)
           return @path if !key
           @hash_paths[key.upcase]
         end
 
+        # Helper to assign tags to a person account.
+        # * It preserves the `:initial` order, in case the `:final` tags are the same
+        #
+        # @example Usage example:
+        #     tree = [{"tag" => "Australia", "nodes" => [
+        #          {"tag" => "SYNDEY", "nodes" => []},
+        #          {"tag" => "MELMOURNE", "nodes" => []}
+        #     ]}]
+        #
+        #     tree = TagTree.new(tree.to_json)
+        #     original = ["SYNDEY", "RISK"]
+        #     final    = ["MELMOURNE", "EVENT"]
+        #
+        #     tree.user_tags(initial: original, final: final) # out: ["MELMOURNE", "RISK"]
+        #     tree.user_tags(initial: original, final: final, preserve_custom: false) # out: ["MELMOURNE"]
+        #     tree.user_tags(initial: original, final: final, add_custom: true) # out: ["MELMOURNE", "RISK", "EVENT"]
+        #     tree.user_tags(initial: original, final: final, preserve_custom: false, add_custom: true) # out: ["MELMOURNE", "EVENT"]
+        #
+        # @param initial [Array<String>] original tags a person has in their account.
+        # @param final [Array<String>] target tags the person should have in their account afterwards.
+        # @param preserve_custom  [Boolean] indicates if original tags that are not in the tree should be added/preserved.
+        # @param add_custom [Boolean] indicates if target tags that are not in the tree should be really added.
+        # @return [Array<String>] with the treated final tags.
         def user_tags(initial: [], final: [], preserve_custom: true, add_custom: false)
           initial = [initial].flatten.compact
           final   = [final].flatten.compact
@@ -64,10 +114,13 @@ module Eco
           (initial & final) + new_tags
         end
 
-        # take the deepest tag (the one that is further down in the tree)
-        # different options (several nodes at the same depth):
-        # => take the common node between them (i.e. you have Hamilton and Auckland -> take New Zealand)
-        # => if there's no common node between them, take the `first` (unless they are at top level of the tree)
+        # Helper to decide which among the tags will be the default.
+        # * take the deepest tag (the one that is further down in the tree)
+        # * if there are different options (several nodes at the same depth):
+        #    * take the common node between them (i.e. you have Hamilton and Auckland -> take New Zealand)
+        #    * if there's no common node between them, take the `first` (unless they are at top level of the tree)
+        # @param [Array<String>] values list of tags.
+        # @return [String] default tag.
         def default_tag(*values)
           values = filter_tags(values)
           nodes = []; depth = -1

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

@@ -16,6 +16,7 @@ module Eco
           EmailAsIdCase.new(self).process
           NewIdCase.new(self).process
           NewEmailCase.new(self).process
+          SwitchSupervisorCase.new(self).process
           SetSupervisorCase.new(self).process
           UpdateDetailsCase.new(self).process
           CreateDetailsCase.new(self).process
@@ -40,6 +41,7 @@ require_relative 'default_cases/email_as_id_case'
 require_relative 'default_cases/new_id_case'
 require_relative 'default_cases/new_email_case'
 require_relative 'default_cases/set_supervisor_case'
+require_relative 'default_cases/switch_supervisor_case'
 require_relative 'default_cases/update_details_case'
 require_relative 'default_cases/create_details_case'
 require_relative 'default_cases/create_details_with_supervisor_case'

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

@@ -0,0 +1,57 @@
+module Eco
+  module API
+    module UseCases
+      class DefaultCases
+        class SwitchSupervisorCase < UseCases::BaseCase
+
+          def process
+            @cases.define("switch-supervisor", type: :transform) do |people, session, options|
+
+              unless old_id = options.dig(:super, :old)
+                session.logger.error("You haven't specified the original supervisor. Aborting...")
+                exit
+              end
+
+              # we could be setting the supervisor to nil
+              unless options[:super].key?(:new)
+                session.logger.error("You haven't specified the new supervisor. Aborting...")
+                exit
+              end
+
+              pp old_id
+              pp new_id =  options.dig(:super, :new)
+
+              unless old_sup = people.person(id: old_id, external_id: old_id, email: old_id)
+                session.logger.error("Couldn't find any user with that id: '#{old_id}'. Aborting...")
+                exit
+              end
+
+              unless new_sup = people.person(id: new_id, external_id: new_id, email: new_id)
+                session.logger.error("Couldn't find any user with that id: '#{new_id}'. Aborting...")
+                exit
+              end
+
+              people = people.supervisor_id(old_sup.id)
+              unless people.length > 0
+                session.logger.error("There are no people with supervisor #{old_sup.external_id} (#{old_sup.name} - #{old_sup.email}). Aborting...")
+                exit
+              end
+
+              session.logger.info("Going to change supervisor '#{old_sup.name}' (#{old_sup.external_id}) to '#{new_sup.name}' (#{new_sup.external_id})")
+
+              # create batch queue
+              supers = session.job_group("main").new("update", type: :update, sets: :core)
+
+              people.each.with_index do |person, i|
+                person.supervisor_id = new_sup.id
+                supers.add(person)
+              end
+
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "0.6.3"
+  VERSION = "0.6.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Oscar Segura
@@ -30,6 +30,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: ecoportal-api
   requirement: !ruby/object:Gem::Requirement
@@ -210,16 +250,13 @@ files:
 - lib/eco/api/common/version_patches/external_person.rb
 - lib/eco/api/eco_faker.rb
 - lib/eco/api/organization.rb
-- lib/eco/api/organization/account.rb
 - lib/eco/api/organization/people.rb
 - lib/eco/api/organization/policy_groups.rb
 - lib/eco/api/organization/preferences.rb
 - lib/eco/api/organization/preferences_reference.json
 - lib/eco/api/organization/presets.rb
-- lib/eco/api/organization/presets_backup.rb
 - lib/eco/api/organization/presets_values.json
 - lib/eco/api/organization/tag_tree.rb
-- lib/eco/api/organization_old.rb
 - lib/eco/api/session.rb
 - lib/eco/api/session/batch.rb
 - lib/eco/api/session/batch_job.rb
@@ -254,6 +291,7 @@ files:
 - lib/eco/api/usecases/default_cases/reset_landing_page_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/switch_supervisor_case.rb
 - lib/eco/api/usecases/default_cases/to_csv_case.rb
 - lib/eco/api/usecases/default_cases/update_details_case.rb
 - lib/eco/api/usecases/default_cases/upsert_account_case.rb

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

@@ -1,23 +0,0 @@
-module Eco
-  module API
-    module Account
-      class Account
-
-        attr_accessor :policy_group_ids, :filter_tags
-        attr_accessor :permissions_preset, :permissions_custom
-        attr_accessor :login_provider_ids
-        attr_accessor :landing_page_id, :preferences, :starred_ids
-        attr_reader :prefilter
-        #attr_reader :presets
-
-        def initialize(init = {})
-          #@presets = AccountPresets.new
-        end
-        def set_details(person)
-
-        end
-        private
-      end
-    end
-  end
-end

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

@@ -1,220 +0,0 @@
-module Eco
-  module API
-    module Account
-
-      #TODO set rules, make Presets immutable, and init from config
-      class PresetsFactory
-        ABILITIES = File.join(__dir__, 'presets_values.json')
-        DEFAULT_CUSTOM = 'presets_custom.json'
-        DEFAULT_MAPS   = 'presets_map.json'
-
-        def initialize(init = {}, policy_groups: [])
-          @abilities = JSON.load(File.open(ABILITIES))
-
-          init_custom(init)
-          init_maps(init)
-
-          @policy_groups         = policy_groups
-          @policy_groups_by_id   = policy_groups.map{ |pg| [pg.id, pg] }.to_h
-          @policy_groups_by_name = policy_groups.map { |pg| [pg.name&.downcase, pg] }.to_h
-        end
-
-        def new(*policy_group_ids_or_names)
-          names = policy_group_ids_or_names.map { |id_name| policy_group_name(id_name) }
-          preset_names = names.map   { |name| @presets_map.fetch(name, nil)   }
-          # validate
-          compile(*preset_names)
-        end
-
-        private
-
-        def policy_group_name(id_name)
-          @policy_groups_by_id.fetch(id_name, nil)&.name&.downcase ||
-          @policy_groups_by_name.fetch(id_name&.downcase, nil)&.name&.downcase
-        end
-
-        def init_custom(init = {})
-          file = File.expand_path(init.fetch('presets_custom', DEFAULT_CUSTOM))
-          @presets_custom = JSON.load(File.open(file))
-        end
-
-        def init_maps(init = {})
-          file = File.expand_path(init.fetch('presets_map', DEFAULT_MAPS))
-          @presets_map = JSON.load(File.open(file))
-        end
-
-        def compile(*preset_names)
-          @presets_custom.values_at(*preset_names).reduce(empty_model) do |p1, p2|
-            merge(p1, p2)
-          end
-        end
-
-        def merge(preset1, preset2)
-          @abilities.map do |key, values|
-            idx = [
-              values.index(preset1[key]),
-              values.index(preset2[key])
-            ].compact.max
-            [key, idx && values[idx]]
-          end.to_h
-        end
-
-        def empty_model
-          JSON.parse(@abilities.to_json).transform_values {|v| nil }
-        end
-
-      end
-
-      class Presets
-        DEFAULT_PRESET = "basic"
-        PRESETS_VALUES = File.join(__dir__, 'presets_values.json')
-        PRESETS_REFERENCE  = File.join(__dir__, 'presets_reference.json')
-
-        attr_reader :default
-        attr_reader :presets_model, :presets_values, :presets_reference
-        attr_reader :native_presets, :featured_presets, :all_presets
-        attr_reader :rules
-        def initialize(init = {})
-          init = {} if !init || !init.is_a?(Hash)
-
-          @presets_values = JSON.load(File.open(PRESETS_VALUES))
-          # get the index of each value of each ability (so we can compare for highest and lowest)
-          @presets_values_hashed = JSON.parse(@presets_values.to_json) \
-            .transform_values {|v| Hash[v.map.with_index.to_a] }
-
-          @presets_model = self.empty_model
-          @presets_reference = init.fetch('reference', JSON.load(File.open(PRESETS_REFERENCE)))
-          @native_presets = ["read_only", "forms", "editor", "administrator", "custom"]
-          @all_presets = @presets_reference.keys
-          @featured_presets = @all_presets - @native_presets
-          @default = init.fetch("default", DEFAULT_PRESET)
-
-          self.set_rules(init.fetch('rules', nil))
-        end
-
-        def set_rules(rules)
-          @rules = rules
-        end
-
-        def empty_model
-          JSON.parse(@presets_values.to_json).transform_values {|v| nil }
-        end
-
-        def is_custom?(preset_name)
-          return (!preset_name || preset_name == "custom")
-        end
-
-        def find_preset(preset)
-          found = @all_presets.select { |ref|
-            preset_ref = @presets_reference.fetch(ref, nil)
-            presets_equal?(preset, preset_ref)
-          }
-          return found.switch()
-        end
-
-        # returns a new hash with presets defaulting to a preset profile
-        def new_model(default = nil)
-          presets_sample = @presets_reference.fetch(default, @presets_model)
-          JSON.parse(presets_sample.to_json)
-        end
-
-        def default_model
-          self.new_model(@default)
-        end
-
-        def get_models(presets_list = [])
-          presets_list.map {|v| self.new_model(v) }
-        end
-
-        def presets_equal?(preset1, preset2)
-        return false if !preset1 || !preset2
-          all_keys = self.new_model.keys
-          # "no access" can / should be nil; or not specified (notice that it is not so for updates)
-          return !all_keys.empty? && all_keys.all? { |key| preset1.fetch(key, nil) == preset2.fetch(key, nil) }
-        end
-
-        # among a set of presets, it returns the presets doc
-        # for each flag, it contains the highest (or lowest) of all the input presets
-        # by giving at least the abilities of the preset min: to each flag
-        # and / or the max: abilities one if specified
-        def merge (presets, highest: true, min: nil, max: nil)
-          max_preset_model = max ? self.new_model(max) : nil
-          min = self.default if min == "default"
-
-          return self.new_model(min).map do |k_flag, min_ability|
-            levels = presets.map {|pre| ability_level(k_flag, pre[k_flag]) }
-
-            min_lev = ability_level(k_flag, min_ability)
-            max_lev = Float::INFINITY
-            if max
-              max_ability = max_preset_model.fetch(k_flag, nil)
-              max_lev = ability_level(k_flag, max_ability)
-            end
-            if highest
-              level = highest(levels, flag: k_flag, min: min_lev, max: max_lev)
-            else
-              level = lowest(levels, flag: k_flag, min: min_lev, max: max_lev)
-            end
-
-            [k_flag, level_ability(k_flag, level)]
-          end.to_h
-        end
-
-        def self.test(num = 2, min: "random", max: "random")
-          account_presets = self.new
-          all_presets = account_presets.all_presets
-
-          num = rand(2..5) if num == "random"
-          list_types = all_presets.sample(num)
-
-          min = rand > 0.5 if min == "random"
-          max = rand > 0.5 if max == "random"
-
-          min = all_presets.sample(1).first if (!!min === min) && min
-          max = all_presets.sample(1).first if (!!max === max) && max
-
-          presets = account_presets.get_models(list_types)
-
-          puts "min: #{min}; max: #{max}" if min || max
-          puts "chosen presets: #{list_types}"
-          puts "pre-merge models: #{presets}"
-          pp account_presets.merge(presets)  unless min || max
-          pp account_presets.merge(presets, min: min, max: max) if min && max
-          pp account_presets.merge(presets, min: min) if min && !max
-          pp account_presets.merge(presets, max: max) if !min && max
-        end
-
-        private
-
-        # given an array list of values for a flag
-        # it returns the highest of all the abilities
-        def highest(list, flag:, min: 0, max: Float::INFINITY)
-          m = (list + [min]).max
-          return (max < m)? max : m
-        end
-
-        # it returns the highest of all the values
-        def lowest(list, flag:, min: 0, max: Float::INFINITY)
-          m = (list + [max]).min
-          return (min > m)? min : m if min
-          return m
-        end
-
-        # given an ability of a flag
-        # it returns the level of that flag
-        def ability_level(flag, ability)
-          return 0 unless ability
-          return @presets_values_hashed.dig(flag, ability)
-        end
-
-        # given a level of one flag
-        # it returns the ability of that flag
-        def level_ability(flag, level)
-          return nil unless level && level > 0
-          return @presets_values[flag][level]
-        end
-
-      end
-    end
-  end
-end

data/lib/eco/api/organization_old.rb

@@ -1,73 +0,0 @@
-module Eco
-  module API
-    #TODO move as part of API::Session and inherit from < API::Common::Session::BaseModel
-    #TODO boost autoconfiguration (via file <- FileManager.dir)
-    class Organization
-
-      DUMMY_USER_EXTERNAL_ID = 'dummy'
-
-      attr_reader :tag_tree, :policy_groups, :person_schemas
-      attr_reader :default_person, :default_schema, :default_schema_id
-      attr_reader :default_policy_group_ids, :default_filter_tags, :default_login_provider_ids
-      attr_reader :login_providers
-      attr_reader :account_presets, :account_preferences
-
-      def initialize(init = {})
-        api = init.fetch('api', nil)
-        @@api = api&.instance_of?(Ecoportal::API::Internal) && api
-        # todo: maps { 'policy_group' : 'preset'}
-        set_settings(init, override: true)
-      end
-
-      def set_settings(init = {}, override: false)
-        set_defaults(init)
-        @login_providers = init['login_providers'] || @@api&.login_providers&.to_a || \
-          @login_providers ||  [] if (!@login_providers || :override)
-        @tag_tree = init['tag_tree'] || @default_filter_tags || @tag_tree || [] if (!@tag_tree || :override)
-        @policy_groups = init['policy_groups'] || @@api&.policy_groups&.to_a || \
-          @policy_groups ||  [] if (!@policy_groups || :override)
-
-        @person_schemas = init['person_schemas'] || @@api&.person_schemas&.to_a || @person_schemas || \
-          [@default_schema] || [] if (!@person_schemas || :override)
-      end
-
-      def default_schema=(value)
-        @default_schema = value || @person_schemas&.first
-        self.default_schema_id = @default_schema&.id || @default_schema&.schema_id || @default_schema_id
-      end
-
-      def default_schema_id=(value)
-        @default_schema_id = value
-      end
-
-      private
-
-      def set_defaults(init = {})
-        @account_presets = Account::Presets.new(init.fetch('presets', nil))
-        @account_preferences = Account::Preferences.new
-
-        @default_person = get_default_person(init)
-        @default_policy_group_ids = init['default_policy_group_ids'] || @default_person&.account&.policy_group_ids || []
-        @default_filter_tags = init['default_filter_tags'] || @default_person&.account&.filter_tags || []
-        @default_login_provider_ids = init['default_login_provider_ids'] || @default_person&.account&.login_provider_ids || []
-        default_schema = get_schema_from_person(@default_person)
-        self.default_schema = init['default_schema'] || default_schema
-      end
-
-      def get_default_person(init = {})
-        return nil if !@@api
-        return init.fetch('default_person', (@@api && @@api.people.get(DUMMY_USER_EXTERNAL_ID)).result || nil)
-      end
-
-      def get_schema_from_person(person)
-        return nil if !person
-        doc = person.details.doc
-        doc['id'] = doc['schema_id']
-        doc.delete('schema_id')
-        schema = Ecoportal::API::Internal::PersonSchema.new(doc)
-        return schema
-      end
-
-    end
-  end
-end