eco-helpers 3.2.2 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 415f7627b23706adc59420467cd7491f5990c267109a11f9128fa8dac908631c
-  data.tar.gz: 8f04152b0e476c656c83fe752b091e83e042a322d0cdbb69e26bb8650c812f07
+  metadata.gz: b3323b0394649126c76ec4239eade6cca337049bd8f761f96aa7c66034717bd0
+  data.tar.gz: 3ddedb00b3b1e7674e014143e54e9cb46e52abb9482e9dfbc65dd4059fd0a70e
 SHA512:
-  metadata.gz: 9cb01334ae6ae73d528f5841c568ee3f13305cabf5051d5ef2bee3775d9dac5d6618a16436f62fa28ff9c06ba628ca1c04897e528ba3a367db8a8805affc4f44
-  data.tar.gz: 6e9fe1d5c9cbda796692302ad551702c446ee73a44bdd83cb3e04a59de0ef3474e878d071d6977cd68fc7f0d19256a334a2c014c62ec79b63c918ad5d6463c48
+  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.3.1] - 2025-06-xx
+## [3.2.4] - 2025-08-xx
 
 ### Added
 
@@ -10,6 +10,21 @@ 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

data/eco-helpers.gemspec

@@ -41,8 +41,8 @@ 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.3',  '>= 1.3.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'

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[

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/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/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)

data/lib/eco/api/usecases/graphql/helpers/location/command/end_points/optimizations.rb

@@ -0,0 +1,64 @@
+module Eco::API::UseCases::GraphQL::Helpers::Location
+  module Command::EndPoints
+    module Optimizations
+      DEFAULT_COMMANDS_PER_PAGE = 45
+
+      # Available options are:
+      #   - :per_request -> on each request
+      #   - :per_batch   -> at the end of each batch / stage (on last page)
+      #   - :once        -> only when the script starts to run
+      # @return [Symbol] the default tree tracking mode
+      def default_tree_tracking_mode
+        :per_request # :per_batch @todo per batch/stage is more plausible
+      end
+
+      # Helper to identify the commands payload block
+      # @note
+      #   1. Gives flexibility on at what time the structure should be retrieved
+      #   2. This increases performacne, as we don't retrieve the full tree on
+      #     each request unless necessary/specified
+      #   3. `nil` falls the block back to the `ecoportal-api-graphql` gem, which
+      #     has a default block that retrieves the structure
+      # @return [Proc, NilClass] the payload block
+      def scope_commands_block(track_tree_mode: default_tree_tracking_mode)
+        case track_tree_mode
+        when :per_request
+          nil
+        when :once, :per_batch
+          commands_payload_without_structure_block
+        end
+      end
+
+      # Prevents each request from timing out
+      def commands_per_page
+        if self.class.const_defined?(:COMMANDS_PER_PAGE)
+          self.class::COMMANDS_PER_PAGE
+        else
+          DEFAULT_COMMANDS_PER_PAGE
+        end
+      end
+
+      # Whether to stop or continue on command fail
+      def force_continue?
+        false
+      end
+
+      # Commands payload without querying Structure
+      # @note this servces the purpose of optimizing/speeding up the requests.
+      def commands_payload_without_structure_block
+        proc {
+          clientMutationId
+          ok
+          errors { # rubocop:disable Style/BlockDelimiters
+            details
+            fullMessages
+            messages
+          }
+          draft { # rubocop:disable Style/BlockDelimiters
+            ___Ecoportal__API__GraphQL__Fragment__LocationDraft
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+module Eco::API::UseCases::GraphQL::Helpers::Location
+  module Command::EndPoints
+    include Eco::Language::AuxiliarLogger
+    include Eco::API::UseCases::GraphQL::Helpers::Location::Base
+
+    require_relative 'end_points/optimizations'
+
+    include Optimizations
+
+    def create_draft(
+      structure_id,
+      name:                   Time.now.iso8601,
+      notes:                  '',
+      include_archived_nodes: true
+    )
+      log(:info) { "Going to create draft (for #{structure_id})..." }
+
+      graphql.locationStructure.draft.create(
+        input:                {
+          structureId: structure_id,
+          name:        name,
+          notes:       notes
+        },
+        includeArchivedNodes: include_archived_nodes
+      ).tap do |payload|
+        unless payload.error?
+          log(:info) { "Created draft '#{payload.draft&.id}' (for #{structure_id})" }
+          next
+        end
+
+        msg = "Could not create draft for #{structure_id}:\n"
+        msg << JSON.pretty_generate(payload.error_doc)
+
+        raise StandardError, msg
+      end
+    end
+
+    def delete_draft(draft_id)
+      graphql.locationStructure.draft.delete(
+        input: {
+          id: draft_id
+        }
+      ).tap do |payload|
+        unless payload.error?
+          log(:info) { "Deleted draft #{draft_id}" }
+          next
+        end
+
+        msg = "Could not delete draft #{draft_id}:\n"
+        msg << JSON.pretty_generate(payload.error_doc)
+
+        raise StandardError, msg
+      end
+    end
+
+    def publish_draft(
+      draft_id,
+      preview:                false,
+      force:                  false,
+      include_archived_nodes: true
+    )
+      log(:info) { "Going to publish draft #{draft_id}..." }
+
+      graphql.locationStructure.draft.publish(
+        input:                {
+          id:      draft_id,
+          preview: preview,
+          force:   force
+        },
+        includeArchivedNodes: include_archived_nodes
+      ).tap do |payload|
+        unless payload.error?
+          log(:info) { "Published draft #{draft_id}" }
+          next
+        end
+
+        msg = "Could not publish draft #{draft_id}:\n"
+        msg << JSON.pretty_generate(payload.error_doc)
+
+        raise StandardError, msg
+      end
+    end
+
+    def apply_commands(
+      input,
+      final:           false,
+      track_tree_mode: nil,
+      &block
+    )
+      block ||= scope_commands_block(track_tree_mode: track_tree_mode)
+      block   = nil if final
+
+      graphql.locationStructure.draft.addCommands(input: input, &block)
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module Eco::API::UseCases::GraphQL::Helpers::Location::Command
+  class InputUnitResponse
+    attr_reader :input, :response
+
+    def initialize(input, response)
+      @input    = input
+      @response = response
+    end
+
+    def draft
+      response&.draft
+    end
+
+    def structure
+      draft&.structure
+    end
+
+    def commands
+      input[:commands]
+    end
+
+    # brief summary of the error
+    def error_doc
+      if (err_doc = response&.error_doc)
+        return err_doc
+      end
+
+      conflictingIds if conflictingIds?
+    end
+
+    def error?
+      return false if response.nil?
+      return true  if conflictingIds?
+
+      response.error? # draft might have previous, but we will stop anyway!
+    end
+    alias_method :errors?, :error?
+
+    def ok?
+      !errors?
+    end
+
+    def conflictingIds? # rubocop:disable Naming/MethodName
+      conflictingIds.any?
+    end
+
+    def conflictingIds # rubocop:disable Naming/MethodName
+      draft_conflicting_ids & target_ids
+    end
+
+    private
+
+    def draft_conflicting_ids
+      return [] unless draft
+
+      draft.conflictingIds || []
+    end
+
+    def target_ids
+      return [] unless commands.is_a?(Array)
+
+      commands.map do |cmd|
+        next cmd.target_ids if cmd.respond_to?(:target_ids)
+
+        cmd.values_at(:nodeId, :newId, :id)
+      end.flatten.compact.uniq
+    end
+  end
+end

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

@@ -7,14 +7,11 @@ module Eco::API::UseCases::GraphQL::Helpers::Location::Command
       @result = result
     end
 
-    def command
+    # @return [Symbol] the command type
+    def command_type
       input.keys.first
     end
 
-    def command_input_data
-      input[command]
-    end
-
     def node_id
       command_input_data[:nodeId]
     end
@@ -24,7 +21,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Location::Command
     end
 
     def applied?
-      !pending?
+      !pending? && success?
     end
 
     def success?
@@ -47,20 +44,24 @@ module Eco::API::UseCases::GraphQL::Helpers::Location::Command
 
       feed = []
       feed.concat(error.validationErrors.map(&:message)) unless error.validationErrors.empty?
-      feed << "Command: #{command_input_data.pretty_inspect}"
+      feed << "Command: #{JSON.pretty_generate(command_input_data)}"
 
       msg  << "  * #{feed.join("\n  * ")}"
       msg.join("\n")
     end
 
-    def command_result
+    def command_result_data
       result&.command
     end
 
+    def command_input_data
+      input[command]
+    end
+
     def command_id
-      return unless result
+      return unless command_result_data
 
-      command_result['id']
+      command_result_data['id']
     end
 
     def as_json