eco-helpers 3.2.1 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea80ab87a718ddf4e177e212b1f4a5234c96554d67d4781579314d1e58ea821e
-  data.tar.gz: 835aec5ee8d25e186f3327e97b5ca382a3556c85a8f34bed4e4e3f09b2d201c0
+  metadata.gz: b3323b0394649126c76ec4239eade6cca337049bd8f761f96aa7c66034717bd0
+  data.tar.gz: 3ddedb00b3b1e7674e014143e54e9cb46e52abb9482e9dfbc65dd4059fd0a70e
 SHA512:
-  metadata.gz: 16cd391227194d4e929292ebe775f061f1ba58f592523ff28b32d2d7e92da638c94c0b36fdf2f55f2c38195517f6def5441e8ae15a6a3a516f02b5357540a69b
-  data.tar.gz: 4bad0d9fa30a1be333b69aa485808961a3ae39259fb42d616457b8cd2b501b808daf60526cf0d4f17540f42036b084b82f40aeae36dd25894df46735b5f1f91e
+  metadata.gz: 6b6126ec90b13ef1d2d985b384215a529b5818ff5d8139d96fe80d5c21c6a4a0b367cb9bb7bf8b92ff6ed61f3df525f35e2639b5160693cc0e2fd6109bfb02cb
+  data.tar.gz: d4b799b66943fda1cf7340f358520d1f30715e27866ba900615cedc5bab593200a53cb2ef72bb6ff04c8e8b4e7c4b1b6bd1b0240145240364f67f633fbb3fbd6

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.2.2
+  TargetRubyVersion: 3.2
   Exclude:
     - 'config/routes.rb'
   NewCops: enable

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.2.2] - 2025-05-xx
+## [3.2.4] - 2025-08-xx
 
 ### Added
 
@@ -10,6 +10,41 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [3.2.3] - 2025-08-21
+
+### Added
+
+- `Person#phone_number`
+
+### Changed
+
+- upgraded dependencies
+  - `ecoportal-api` gem
+
+### Fixed
+
+- Switched to use DRAFTs on RS updates
+
+## [3.2.2] - 2025-06-11
+
+### Added
+
+- `PersonEntry#[]` accessor (onto `final_entry`)
+- **Samples**:
+  - `require-id`
+  - `require-min-entries`
+
+### Changed
+
+- upgraded gem dependencies
+- `Session::Batch::Searcher` silence low level messages.
+  - And better feedback on search.
+- **Refactored** `Microcases` people get/cache/load helpers to reach a **unique access point** per functionality.
+
+### Fixed
+
+- The upgrade of the `ecoportal-api-graphql` **gem** fixes a bug introduced by a native release.
+
 ## [3.2.1] - 2025-05-17
 
 ### Changed

data/eco-helpers.gemspec

@@ -41,9 +41,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'bcrypt_pbkdf',  '~> 1.0'
   spec.add_dependency 'docx',          '>= 0.8.0', '< 0.9'
   spec.add_dependency 'dotenv',        '~> 3'
-  spec.add_dependency 'ecoportal-api',         '~> 0.10', '>= 0.10.11'
-  spec.add_dependency 'ecoportal-api-graphql', '~> 1.2',  '>= 1.2.1'
-  spec.add_dependency 'ecoportal-api-v2',      '~> 3.2',  '>= 3.2.1'
+  spec.add_dependency 'ecoportal-api',         '~> 0.10', '>= 0.10.14'
+  spec.add_dependency 'ecoportal-api-graphql', '~> 1.3',  '>= 1.3.2'
+  spec.add_dependency 'ecoportal-api-v2',      '~> 3.3',  '>= 3.3.1'
   spec.add_dependency 'ed25519',       '~> 1.2'
   spec.add_dependency 'fast_excel',    '>= 0.5.0',  '< 0.6'
   spec.add_dependency 'fuzzy_match',   '>= 2.1.0',  '< 2.2'

data/lib/eco/api/common/loaders/config/workflow/mailer.rb

@@ -75,6 +75,7 @@ class Eco::API::Common::Loaders::Workflow::Mailer < Eco::API::Common::Loaders::W
       host(io).downcase.start_with?('live.')
     end
 
+    # @note this initiates a connection to the API (undesired)
     def host(io)
       io.session.api.client.host
     end

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

@@ -9,7 +9,7 @@ module Eco
           BOOLEAN_ATTRS = %w[
             freemium accept_eula archived
           ].freeze
-          MULTI_ATTRS   = %w[
+          MULTI_ATTRS = %w[
             policy_group_ids filter_tags login_provider_ids starred_ids
           ].freeze
           NUMERIC_ATTRS = %w[
@@ -98,6 +98,11 @@ module Eco
             end
           end
 
+          # Value on the final entry
+          def [](key)
+            final_entry[key]
+          end
+
           # @note completely serialized entry.
           # @return [Hash] entry `Hash` with **external** attribute names, and values and types thereof.
           def external_entry # rubocop:disable Style/TrivialAccessors

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

@@ -17,6 +17,7 @@ module Eco
 
           CORE_ATTRS = %w[
             id external_id email name
+            phone_number
             supervisor_id filter_tags
             archived
             contractor_organization_id

data/lib/eco/api/microcases/people/manage/cache.rb

@@ -4,29 +4,34 @@ module Eco
       module People
         module Manage
           module Cache
-            # Helper to locally cache the people manager.
+            # Helper to locally cache the people manager (download via API).
             # @param filename [String] the name of the file where the data should be cached.
             # @return [Eco::API::Organization::People] the `People` object with the data.
-            def people_cache(filename = enviro.config.people.cache)
-              log(:info) { 'Going to get all the people via API' }
+            def people_cache(filename = enviro.config.people.cache, modifier: [:save])
+              modifier = [modifier].flatten
 
-              start   = Time.now
-              people  = session.batch.get_people
-              secs    = (Time.now - start).round(3)
-              cnt     = people.count
-              per_sec = (cnt.to_f / secs).round(2)
+              log(:info) { 'Going to get all the people via API' }
 
-              log(:info) {
-                "Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)"
-              }
+              start = Time.now
+              session.batch.get_people.tap do |people|
+                secs    = (Time.now - start).round(3)
+                cnt     = people.count
+                per_sec = (cnt.to_f / secs).round(2)
 
-              file = file_manager.save_json(people, filename, :timestamp)
+                log(:info) {
+                  "Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)"
+                }
 
-              log(:info) {
-                "#{people.length} people loaded and saved locally to #{file}."
-              }
+                if modifier.include?(:save)
+                  file = file_manager.save_json(people, filename, :timestamp)
 
-              Eco::API::Organization::People.new(people)
+                  log(:info) {
+                    "#{people.length} people loaded and saved locally to #{file}."
+                  }
+                end
+              end.then do |people|
+                Eco::API::Organization::People.new(people)
+              end
             end
           end
         end

data/lib/eco/api/microcases/people/manage/filename.rb

@@ -0,0 +1,29 @@
+module Eco
+  module API
+    class MicroCases
+      module People
+        module Manage
+          module Filename
+            private
+
+            # Spot the source data file.
+            def people_filename(filename = enviro.config.people.cache, newest: false)
+              if newest
+                # search input file based on pattern (in case the name has a timestamp)
+                file_manager.dir.newest_file(file: filename).tap do |file|
+                  next unless file
+
+                  log(:info) {
+                    "previous file found: #{file}"
+                  }
+                end
+              else
+                file_manager.dir.file(filename, should_exist: true)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/microcases/people/manage/load.rb

@@ -22,19 +22,10 @@ module Eco
               modifier  = [modifier].flatten
               load_file = %i[file newest].any? {|flag| modifier.include?(flag)}
 
-              case
-              when filename && load_file
-                file = people_load_filename(filename, newest: modifier.include?(:newest))
+              if filename && load_file
+                load_cache(filename, newest: modifier.include?(:newest)).tap do |people|
+                  next if people.is_a?(Eco::API::Organization::People)
 
-                if file
-                  file_manager.load_json(file).tap do |people|
-                    next unless people.is_a?(Array)
-
-                    log(:info) {
-                      "#{people&.length} people loaded from file #{file}"
-                    }
-                  end
-                else
                   log(:error) {
                     "could not find the file #{file_manager.dir.file(filename)}"
                   }
@@ -43,43 +34,10 @@ module Eco
 
                   people_load(modifier: modifier - %i[newest file])
                 end
-              when modifier.include?(:api)
-                log(:info) { 'Going to get all the people via API (load)' }
-
-                start = Time.now
-                session.batch.get_people.tap do |people|
-                  secs    = (Time.now - start).round(3)
-                  cnt     = people.count
-                  per_sec = (cnt.to_f / secs).round(2)
-
-                  log(:info) {
-                    "Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)"
-                  }
-
-                  if modifier.include?(:save) && people && people.length.positive?
-                    file = file_manager.save_json(people, filename, :timestamp)
-                    log(:info) { "#{people.length} people saved to file #{file}." }
-                  end
-                end
+              elsif modifier.include?(:api)
+                people_cache(filename, modifier: modifier)
               end.then do |people|
-                Eco::API::Organization::People.new(people)
-              end
-            end
-
-            private
-
-            def people_load_filename(filename, newest: false)
-              if newest
-                # search input file based on pattern (in case the name has a timestamp)
-                file_manager.dir.newest_file(file: filename).tap do |file|
-                  next unless file
-
-                  log(:info) {
-                    "previous file found: #{file}"
-                  }
-                end
-              else
-                file_manager.dir.file(filename, should_exist: true)
+                Eco::API::Organization::People.new(people.to_a)
               end
             end
           end

data/lib/eco/api/microcases/people/manage/load_cache.rb

@@ -0,0 +1,29 @@
+module Eco
+  module API
+    class MicroCases
+      module People
+        module Manage
+          module LoadCache
+            private
+
+            # Finds the source data file and loads it.
+            # @return [Eco::API::Organization::People] the `People` object with the data.
+            def load_cache(filename = enviro.config.people.cache, newest: false)
+              return unless (file = people_filename(filename, newest: newest))
+
+              file_manager.load_json(file).then do |people|
+                next unless people.is_a?(Array)
+
+                log(:info) {
+                  "#{people&.length} people loaded from file #{file}"
+                }
+
+                Eco::API::Organization::People.new(people)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/microcases/people/manage/refresh.rb

@@ -5,16 +5,18 @@ module Eco
         module Manage
           module Refresh
             # Helper to obtain all the elements of `people` anew from the _People Manager_.
+            # @note it does NOT save to a local file.
             # @note
-            #   1. This helper is normally used to run consecutive usecases, where data needs refresh.
+            #   1. This helper is normally used to run consecutive usecases,
+            #     where data needs refresh.
             #   2. It only includes new people if they are not dirty (they do not have pending updates)
             #     - This contingency wouldn't be necessary if the server worked perfectly.
             # @param people [Eco::API::Organization::People] the people that needs refresh.
             # @param include_created [Boolean] include people created during this session? (will check `:create` batch jobs).
             # @return [Eco::API::Organization::People] the `People` object with the data.
             def people_refresh(people:, include_created: true) # rubocop:disable Metrics/AbcSize
-              people = people.newFrom people.select do |person|
-                !person.new? || !person.dirty?
+              people = people.newFrom people.reject do |person|
+                person.new? && person.dirty?
               end
 
               ini = people.length

data/lib/eco/api/microcases/people/manage.rb

@@ -1,3 +1,5 @@
+require_relative 'manage/filename'
+require_relative 'manage/load_cache'
 require_relative 'manage/cache'
 require_relative 'manage/load'
 require_relative 'manage/search'
@@ -8,6 +10,8 @@ module Eco
     class MicroCases
       module People
         module Manage
+          include Filename
+          include LoadCache
           include Cache
           include Load
           include Search

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

@@ -68,7 +68,13 @@ module Eco
           @path.push(self.id) unless top?
 
           @nodes = @raw_nodes.map.with_index do |cnode, idx|
-            self.class.new(cnode, depth: depth + 1, path: @path.dup, parent: self, _weight: idx)
+            self.class.new(
+              cnode,
+              depth:   depth + 1,
+              path:    @path.dup,
+              parent:  self,
+              _weight: idx
+            )
           end
 
           init_hashes
@@ -199,8 +205,9 @@ module Eco
         # @param max_depth [Boolean] up to what level `depth` nodes should be included.
         # @return [Array[Hash]] where `Hash` is a `node` (i.e. `{"tag" => TAG, "nodes": Array[Hash]}`)
         def as_json( # rubocop:disable Metrics/AbcSize
-          include_children: true, include_archived: true,
-          max_depth: total_depth,
+          include_children: true,
+          include_archived: true,
+          max_depth:        total_depth,
           &block
         )
           max_depth ||= total_depth
@@ -230,7 +237,7 @@ module Eco
             depth + 1
           ]
           node_json = self.class::HEADER.zip(values).to_h
-          node_json["nodes"] = children_json if include_children
+          node_json['nodes'] = children_json if include_children
           node_json = yield(node_json, self) if block_given?
           node_json
         end

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

@@ -56,7 +56,7 @@ module Eco
               entries.each_with_index do |entry, i|
                 if (i % 10).zero?
                   percent = i * 100 / entries.length
-                  print "Searching: #{percent.round}% (#{i}/#{entries.length} entries)\r"
+                  print "Searching in results: #{percent.round}% (#{i}/#{entries.length} entries)\r"
                   $stdout.flush
                 end
 
@@ -75,7 +75,7 @@ module Eco
                 unless email.empty?
                   people_matching = get(
                     params:  params.merge(q: email),
-                    silent:  silent,
+                    silent:  true,
                     options: options
                   ).select do |person|
                     person.email == email
@@ -94,7 +94,7 @@ module Eco
 
           private
 
-          def get(params: {}, silent: false, options: self.options)
+          def get(params: {}, silent: true, options: self.options)
             msg  = 'cannot batch get without api connnection, '
             msg << 'please provide a valid api connection!'
             fatal msg unless (people_api = api&.people)

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

@@ -3,69 +3,72 @@ module Eco
     class Session
       class Config
         class People < BaseConfig
-
           def cache=(file)
-            self["cache"] = file
+            self['cache'] = file
           end
 
           def cache
-            self["cache"] ||= "cache/people.json"
+            self['cache'] ||= 'cache/people.json'
           end
 
           def partial_cache
-            if file = self.cache
-              File.join(File.dirname(file),
-                File.basename(file, File.extname(file)) + "_partial" + File.extname(file)
-              )
-            end
+            return unless (file = self.cache)
+
+            extension = File.extname(file)
+            basename  = File.basename(file, extension)
+
+            File.join(
+              File.dirname(file),
+              "#{basename}_partial#{extension}"
+            )
           end
 
           # specifies if people search should be strict or not
           def strict_search=(value)
-            self["strict_search"] = !!value
+            self['strict_search'] = !!value
           end
 
           def strict_search?
-            self["strict_search"]
+            self['strict_search']
           end
 
           # api queried logs
           def requests_folder=(folder)
-            self["requests_folder"] = folder
+            self['requests_folder'] = folder
           end
 
           def requests_folder
-            self["requests_folder"] ||= "requests"
+            self['requests_folder'] ||= 'requests'
           end
 
           # people to exclude from update feeds
           def discarded_file=(file)
-            self["discarded_file"] = file
+            self['discarded_file'] = file
           end
 
           def discarded_file
-            self["discarded_file"]
+            self['discarded_file']
           end
 
           # with given a person what is the criteria of exclusion
           def api_excluded(&block)
-            return self["api_excluded"] unless block_given?
-            self["api_excluded"] = block
+            return self['api_excluded'] unless block_given?
+
+            self['api_excluded'] = block
           end
 
           # internal-external fields map
           def fields_mapper=(file)
-            self["fields_mapper"] = file
+            self['fields_mapper'] = file
           end
 
           def fields_mapper
-            self["fields_mapper"]
+            self['fields_mapper']
           end
 
           # person model
           attr_key :default_usergroup, :default_schema, :default_login_method
 
-
           def default_usergroup?
             !!default_usergroup
           end
@@ -80,7 +83,7 @@ module Eco
 
           # @return [Hash] with defined pairs format `key` and Person parsers.
           def parsers
-            self["parsers"] ||= {}
+            self['parsers'] ||= {}
           end
 
           # The person parser/serializer for a given format (default `csv`).

data/lib/eco/api/usecases/default/locations/tagtree_upload_case.rb

@@ -1,7 +1,7 @@
 class Eco::API::UseCases::Default::Locations::TagtreeUpload < Eco::API::UseCases::GraphQL::Samples::Location::Command
   require_relative 'cli/tagtree_upload_cli'
 
-  name "tagtree-upload"
+  name 'tagtree-upload'
   type :other
 
   COMMANDS_PER_PAGE = 45
@@ -11,10 +11,28 @@ class Eco::API::UseCases::Default::Locations::TagtreeUpload < Eco::API::UseCases
     false
   end
 
+  def compare_live_with_file?
+    true
+  end
+
+  # # With given the commands, it generates the input of the endpoint mutation.
+  # # @param commands [Array<Hash>]
+  # def input(commands, force_continue: force_continue?)
+  #   {
+  #     clientMutationId: '',
+  #     id:               target_structure_id,
+  #     force:            force_continue,
+  #     commands:         commands
+  #   }
+  # end
+
   # We only define the `:insert` stage
   def inputs(force_continue: force_continue?)
     {}.tap do |stages|
-      stages[:insert] = input(insert_commands, force_continue: force_continue)
+      stages[:insert] = input(
+        insert_commands,
+        force_continue: force_continue
+      )
     end.each do |stage, input|
       yield(input, stage) if block_given?
     end

data/lib/eco/api/usecases/graphql/helpers/location/base/tree_tracking.rb

@@ -29,16 +29,20 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
       # At any moment we want to know how the live tree is
       # @note it also does a backup
       # @return [Eco::API::Organization::TagTree] the latest tree (`current_tree`)
-      def track_current_tree(tree)
+      def track_current_tree(tree) # rubocop:disable Metrics/AbcSize
+        return unless track_current_tree?
         return if simulate?
         return if tree.nil?
 
-        latest_tree = tree if tree.is_a?(Eco::API::Organization::TagTree)
-        if tree.respond_to?(:treeify) && track_current_tree?
+        tree_id     = current_tree&.id
+        tree_name   = current_tree&.name
+        tree_id     = tree.id   if tree.respond_to?(:id)
+        tree_name   = tree.name if tree.respond_to?(:name)
+        latest_tree = tree      if tree.is_a?(Eco::API::Organization::TagTree)
+
+        if tree.respond_to?(:treeify)
           latest_tree ||= Eco::API::Organization::TagTree.new(
-            tree.treeify,
-            id:   tree.id,
-            name: tree.name
+            tree.treeify
           )
         end
 
@@ -46,6 +50,9 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
           next unless latest_tree.is_a?(Eco::API::Organization::TagTree)
           next if latest_tree.empty?
 
+          latest_tree.id   = tree_id   if latest_tree.id.nil?
+          latest_tree.name = tree_name if latest_tree.name.nil?
+
           # a backup happens:
           self.current_tree = latest_tree
         end
@@ -53,7 +60,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
 
       # @param tree [Eco::API::Organization::TagTree, Hash, Array]
       # @return [Boolean] whether or not the backup was created
-      def backup_tree(tree = current_tree || live_tree)
+      def backup_tree(tree = current_tree || live_tree) # rubocop:disable Naming/PredicateMethod
         return false if simulate?
         case tree
         when Eco::API::Organization::TagTree

data/lib/eco/api/usecases/graphql/helpers/location/base.rb

@@ -22,7 +22,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
       log(:warn) { msg }
 
       # a backup happens:
-      return nil unless (self.current_tree = session_live_tree)
+      return unless (self.current_tree = session_live_tree)
 
       @target_structure_id = current_tree.id
     end

data/lib/eco/api/usecases/graphql/helpers/location/command/diff/as_update.rb

@@ -18,7 +18,6 @@ class Eco::API::UseCases::GraphQL::Helpers::Location::Command::Diff
           class_ids = class_ids.compact.map {|val| val.split('|')}.flatten.uniq
           h['classificationIds'] = class_ids
         end
-
         if archive? || insert?
           # We assume archives do not have `move` nor update `id` or `name`
           h['nodeId']   = node_id || node_id_prev

data/lib/eco/api/usecases/graphql/helpers/location/command/diffs/stages/diff_sortable/for_archive.rb

@@ -2,7 +2,6 @@ class Eco::API::UseCases::GraphQL::Helpers::Location::Command::Diffs
   module Stages
     module DiffSortable
       module ForArchive
-
         private
 
         def only_first_ancestor_in_chains(raw_diffs)