eco-helpers 2.5.10 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e5eed9a7b386a3461b4fad2d842d183ccec984eae4149104a2943bda6b84885
-  data.tar.gz: c19b0aa7ba31b41069f4afba73edcd1354e80ecc60aa668aba124ea4960eca1c
+  metadata.gz: c5b781e23d7538417c84762d636b8e10281adce9e5228cef561edf199aba5334
+  data.tar.gz: ab7284a1124a8bece11d8d72e8bdc2f532d746e1da3cfdc264270885d6f867d9
 SHA512:
-  metadata.gz: c83534044499d6a1561cbf5f21f038ec2f03e3a458178555c3b14c87e50e6c9f6d938f960586bae7f04e1ee152aab7c83b34f8f2752eca8d8ca94b9e97faf46f
-  data.tar.gz: 401d2226b3f02ab5b5d67ebddf75498b918bec22ea85bc405c48aee4ea50c32dad56abb230a91a88eabc0a7fa6d448683ef09a3dedd788e8ec61a11d36a258c3
+  metadata.gz: eb069c529b1f318f700672676178c52921b06dcaf2600c1b0f6c3ab5b388f781c17630a0ae4d0b815f206bc74cff8a528ab3f6df53ce5ea9068416b40174b3f2
+  data.tar.gz: 0fe617fa64e3bf666438ac6a8b6bf35eac83c9552280d16f9070443fe7e7b5e7e4c0e28185b5bcf853e6eac40fc465bb29d55c3112621b9d3d979dcac81436bc

data/.gitignore

@@ -3,7 +3,7 @@ Gemfile.lock
 
 # build artifacts
 *.gem
-/.bundle/
+/.bundle
 /vendor/bundle
 /spec/reports/
 /tmp/
@@ -18,4 +18,4 @@ Gemfile.lock
 # rspec failure tracking
 .rspec_status
 scratch.rb
-.byebug_history
+.byebug_history

data/CHANGELOG.md

@@ -1,12 +1,140 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.5.10] - 2023-09-xx
+## [2.6.1] - 2024-02-11
+
+### Added
+  - For use case `Eco::API::UseCases::Default::Locations::TagtreeExtract`
+    - New `-indent` option
+  - `Eco::API::UseCases::UseCase`
+    - Defines on loader object attr reader methods `people`, `input` and `usecase` unless they already exist.
+  - Some class / method helpers
+    - `Eco::Language::Methods::DelegateMissing` to redirect missing methods to one object
+    - `Eco::Language::Methods::DslAble` to allow direct method calls on blocks
+    - `Eco::Language::Klass:WhenInherited` to allow to defined a block that gets called when the class is inherited
+  - **DSL** capabilities (for block calls) for
+    - `Eco::API::Session::Batch::BasePolicy`
+    - `Eco::API::Session::Batch::Job`
+      - `api_excluded` block to be called in the Job's context
+    - `Eco::API::UseCases::BaseIO`
+      - This shortens code lines in workflow blocks
+      - `Eco::API::Session::Config::Workflow#run` has been adapted to boost the evalution of the workflow blocks within the context of the `BaseIO` that is carried throughout all the run process.
+  - **NEW** Loaders
+    - `Eco::API::Custom::Config` (**DSL** alike) allows to open up configuration via class
+      - Redirects to `Eco::API::Common::Loaders::Config`
+      - Re-usable sample child classes can created with the use of `config_block`, which in combination with `when_inherited` will load the basic config to custom config classes.
+    - `Eco::API::Custom::Workflow` (**DSL** alike) allows to open up workflow configurations via class
+      - Redirects to `Eco::API::Common::Loaders::Config::Workflow`
+    - `Eco::API::Custom::Mailer` (first **sample**) allows to just define some constants to modify the generic behaviour of this sample class you will want to inherit to enable mailing workflow.
+      - Redirects to `Eco::API::Common::Loaders::Config::Workflow::Mailer`
+  - `Eco::Assets#cli` able to yield the `cli` to a block
+  - `Eco::API::UseCases::BaseIO#process_case`
+    - **added method** `process_case`, which allows to pass the `io` itself as a paramter.
+    - When this is used, the `output` swap as `input` / `people` is performed (before and after).
+
+### Changed
+  - **IMPORTANT** overriden `Object#inspect` to `to_s` to prevent recursive deep introspection of object internals on `MethodError`
+  - `Eco::API::Common::Loaders::CaseBase`
+    - **removed** attr `usecase`
+  - `Eco::API::UseCases::BaseIO`
+    - `output` can be set on initialization
+    - `#new` carries the `output` as well.
+  - `Eco::API::Session::Config::Workflow`
+    - `#run`
+      - workflow blocks don't require to explicitly return the `BaseIO` when there isn't any to return. It will just keep the `io` as it was before the call.
+      - also made it so the returned io is **always** an **instance of** `Eco::API::UseCases::BaseIO` (so it won't return an instance of a child class). This change can be considered a fix. **Aside note:** only possible now that `output` is carried on through objects of type (so there's there's no data loss in the calls chain) `Eco::API::UseCases::BaseIO` (i.e. `io.new`)
+    - `#for`
+      - **now** it only requires a `block` if no `key` is provided
+    - `Eco::Data::Locations::NodeBase::TagValidations`
+      - made module re-usable, by removing dependency on `clean_id` method.
+  - Improved the **patch** on exception that adds method `#patch_full_message`
+    - Parameter `trace_count` added (`default: -1` for full trace)
+
+### Fixed
+  - `Eco::Data::Locations::NodeBase::Treeify`
+    - **bug** on strings and interpolation when building the warning/error messages
+    - **added** detection and _warnings_ for **unlinked parents**: as `get_children` is called from the top via `nil` (those that are top level nodes), and all the call chain to collect children goes through their `parent_id` relationship.
+      - If the input nodes had some where there's no direct link between `nil` and a node `id` that is a `parent_id`, `parents[node.id]` would never be called. Meaning that in an input with a list of nodes, there could be clusters of subtrees that do not add/link to the top level (`nil`).
+      - It now gathers those separated subtrees in an `Array` parameter called `unlinked_trees`
+  - `Eco::API::Session::Config::Workflow`
+    - Returning an `Eco::API::UseCases::BaseIO` from callbacks `before`, `after` and `run` would raise an `ArgumentError`.
+    - **Now** the original `io` is returned otherwise the returned value is a `BaseIO`
+  - `Eco::API::Session::Config::Workflow`
+    - **changed** `open` to alias method for `with` (open was clashing)
+  - `Eco::API::UseCases::GraphQL::Helpers::Location::Base`
+    - **removed** `enviro` param for org tagtree built
+  - `Eco::API::UseCases::Cli::DSL`
+    - `::callback` was not acting like a DSL method, which would just return `nil` always (lost `block`)
+    - CLI arguments are unique. If a Cli class has already been run, no need to re-run it. Cli class re-usability is still not in the pipeline, and therefore, it must be run only once.
+  - `Eco::Data::Locations::NodePlain`
+    - `serializer` referred to an non existing constant.
+    - **IMPORTANT** `parent_id` should be `cleaned` as well. Otherwise parents with an id cleanage don't match their children's `parent_id`
+  - `Eco::API::Common::ClassHelpers`
+    - `::inerited` method must call `super` to be able to chain other calls
+  - `Eco::API::Common::Session::Mailer`
+    - The logging message was not printing who the email was sent to.
+
+## [2.6.0] - 2024-02-03
+
+### Added
+  - New use case to `-export-tree` (**tagtree extract**)
+    - `Eco::API::UseCases::Default::Locations::TagtreeExtract`
+  - `Eco::API::UseCases::UseCase`
+    - added `#classed_definition` to expose the original class definition
+    - injected further parameter as instance variables to the original class definition on run-time.
+  - Expose `live_trees` retrieval:
+    - `Eco::API::Session#live_trees`
+    - `Eco::API::Session::Config#live_trees`
+  - Ability to CLI-integrate use cases and their options via class
+    - `Eco::API::UseCases::Cli`
+  - Added use case to extract live locations structure (`-export-tree`)
+    - `Eco::API::UseCases::GraphQL::Cases::TagtreeExtract`
+  - `#api?` method to check if an API version is available
+    - `Eco::API::Common::Session::Environment#api?`
+    - `Eco::API::Common::Session::BaseSession#api?`
+  - `Eco::API::Organization::TagTree#merge` the merge method for tagtrees
+    - It allows to have all structure nodes available to check if a tag belongs to them
+  - `Eco::API::Session::Config::Workflow`
+    - **added** `open` alias method for `for`
+  - `Eco::Data::Mapper#self_mapped?` to check if a value maps to itself
+
+### Changed
+  - upgrade `ecoportal-api-graphql`, `ecoportal-api-v2` and `ecoportal-api`
+  - `Eco::API::Session#tagtree`: added parameters to be able to obtain:
+    - `:live` live trees if graphql api is available on the enviro
+    - `:merge` to merge all live trees if there isn't just one
+  - Tagtree retrieval: remove `enviro` param where there's no caching
+    - Removed also from `Eco::API::Organization::TagTree::new`
+  - Removed some use cases:
+    - `Eco::API::UseCases::DefaultCases::AbstractPolicyGroupAbilities`
+    - `Eco::API::UseCases::DefaultCases::AppendUsergroupsCase`
+    - `Eco::API::UseCases::DefaultCases::CreateDetailsCase`
+    - `Eco::API::UseCases::DefaultCases::CreateDetailsWithSupervisorCase`
+    - `Eco::API::UseCases::DefaultCases::EmailAsIdCase`
+    - `Eco::API::UseCases::DefaultCases::NewIdCase`
+    - `Eco::API::UseCases::DefaultCases::RemoveAccountSyncCase`
+    - `Eco::API::UseCases::DefaultCases::RemoveAccountTransCase`
+    - `Eco::API::UseCases::DefaultCases::NewEmailCase`
+    - `Eco::API::UseCases::DefaultCases::SetSupervisorCase`
+    - `Eco::API::UseCases::DefaultCases::TagTree`
+    - `Eco::API::UseCases::DefaultCases::UpdateDetailsCase`
+    - `Eco::API::UseCases::DefaultCases::ResetLandingPageCase`
+  - Moved some default use cases to new namespace `Eco::API::UseCases::Default`
+
+### Fixed
+  - Compatibility with `ruby 3`
+    - replaced `Proc.new` (with no block) by `block` in methods
+    - replaced `File#exists?` by `File#exist?`
+    - call to method's `super` not specifying args, no longer passes keyed/named args via simple splat `*` (but only double splat `**`)
+  - limit `nokogiri` gem to prev `1.16` (as it requires ruby 3 from thereon)
+  - `Eco::API::Common::People::PersonEntryAttributeMapper`
+    - `#aliased_attrs` was missing internal attrs that have been mapped directly as external attrs (same ext attr name as int attr name)
+
+## [2.5.10] - 2023-11-22
 
-### Added
-### Changed
 ### Fixed
- - `Eco::API::UseCases::DefaultCases::ReinviteSyncCase` remove unnecessary additional parameters on call.
+  - `Eco::API::UseCases::DefaultCases::ReinviteSyncCase` remove unnecessary additional parameters on call.
+  - `Eco::API::Session::Config::SFTP#enviro_subpaths` provided that a current workaround can be skipped
 
 ## [2.5.9] - 2023-09-05
 

data/README.md

@@ -17,3 +17,8 @@ And then execute:
 Or install it yourself as:
 
     $ gem install eco-helpers
+
+
+## Changelog
+
+See {file:CHANGELOG.md} for a list of changes.

data/eco-helpers.gemspec

@@ -24,24 +24,28 @@ Gem::Specification.new do |spec|
   #spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",   ">= 2.4.8",  "< 3"
-  spec.add_development_dependency "rspec",     ">= 3.10.0", "< 4"
+  spec.add_development_dependency "bundler",   ">= 2.4.12", "< 3"
+  spec.add_development_dependency "rspec",     ">= 3.12.0", "< 4"
   spec.add_development_dependency "rake",      ">= 13.0.3", "< 14"
-  spec.add_development_dependency "yard",      ">= 0.9.26", "< 1"
-  spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 4"
+  spec.add_development_dependency "yard",      ">= 0.9.34", "< 1"
+  spec.add_development_dependency "redcarpet", ">= 3.6.0",  "< 4"
 
-  spec.add_dependency 'ecoportal-api', '>= 0.9.5', '< 0.10'
-  spec.add_dependency 'ecoportal-api-v2', '>= 1.1.3', '< 1.2'
-  spec.add_dependency 'ecoportal-api-graphql', '>= 0.3.11', '< 0.4'
-  spec.add_dependency 'aws-sdk-s3',    '>= 1.83.0', '< 2'
-  spec.add_dependency 'aws-sdk-ses',   '>= 1.36.0', '< 2'
-  spec.add_dependency 'dotenv',        '>= 2.7.6',  '< 3'
-  spec.add_dependency 'net-sftp',      '>= 3.0.0',  '< 4'
-  spec.add_dependency 'hashdiff',      '>= 1.0.1',  '< 1.1'
+  spec.add_dependency 'ecoportal-api',         '>= 0.9.6', '< 0.10'
+  spec.add_dependency 'ecoportal-api-v2',      '>= 1.1.5', '< 1.2'
+  spec.add_dependency 'ecoportal-api-graphql', '>= 0.3.13', '< 0.4'
+  spec.add_dependency 'aws-sdk-s3',    '>= 1.142.0', '< 2'
+  spec.add_dependency 'aws-sdk-ses',   '>= 1.58.0', '< 2'
+  spec.add_dependency 'dotenv',        '>= 2.8.1',  '< 3'
+  spec.add_dependency 'net-ssh',       '>= 7.2.1',  '< 8'
+  spec.add_dependency 'net-sftp',      '>= 4.0.0',  '< 5'
+  spec.add_dependency 'hashdiff',      '>= 1.1.0',  '< 1.2'
   spec.add_dependency 'fuzzy_match',   '>= 2.1.0',  '< 2.2'
-  spec.add_dependency 'amatch',        '>= 0.4.0',  '< 0.5'
-  spec.add_dependency 'jaro_winkler',  '>= 1.5.4',  '< 1.6'
-  spec.add_dependency 'roo',           '>= 2.8.3',  '< 2.9'
+  spec.add_dependency 'amatch',        '>= 0.4.1',  '< 0.5'
+  spec.add_dependency 'jaro_winkler',  '>= 1.5.6',  '< 1.6'
+  spec.add_dependency 'nokogiri',      '>= 1.13',   '< 1.17'
+  spec.add_dependency 'roo',           '>= 2.10.1', '< 2.11'
   spec.add_dependency 'roo-xls',       '>= 1.2.0',  '< 1.3'
-  spec.add_dependency 'docx',          '>= 0.6.2',  '< 0.7'
+  spec.add_dependency 'fast_excel',    '>= 0.5.0',  '< 0.6'
+  spec.add_dependency 'docx',          '>= 0.8.0',  '< 0.9'
+  spec.add_dependency 'rubyzip',       '>= 2.3.2',  '< 2.4'
 end

data/lib/eco/api/common/class_helpers.rb

@@ -129,13 +129,13 @@ module Eco
         #   - mutating methods would reflect the changes on other classes as well
         #   - therefore, `freeze` will be called on the values that are inherited.
         def inherited(subclass)
+          super
           inheritable_class_vars.each do |var|
             instance_var = instance_variable_name(var)
             value        = instance_variable_get(instance_var)
             subclass.instance_variable_set(instance_var, value.freeze)
           end
         end
-
       end
     end
   end

data/lib/eco/api/common/loaders/base.rb

@@ -30,10 +30,6 @@ module Eco
             raise "You should implement this method"
           end
 
-          def name
-            self.class.name
-          end
-
           private
 
           def session
@@ -54,11 +50,8 @@ module Eco
 
           def abort(msg, raising: true)
             logger.error(msg)
-            if raising
-              raise msg
-            else
-              exit(1)
-            end
+            raise msg if raising
+            exit 1
           end
         end
       end

data/lib/eco/api/common/loaders/case_base.rb

@@ -20,8 +20,6 @@ module Eco
             end
           end
 
-          attr_reader :usecase
-
           def name
             self.class.name
           end

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

@@ -0,0 +1,78 @@
+class Eco::API::Common::Loaders::Workflow::Mailer < Eco::API::Common::Loaders::Workflow
+  ORG = 'your organization'.freeze
+  TRACE_COUNT = 3
+
+  inheritable_class_vars :config_block
+
+  config_block do
+    puts "running from class #{self}"
+    exception do |err, io|
+      self.error = err
+      log(:debug) { err.patch_full_message }
+      workflow.run(:close, io: io)
+    end
+
+    after(:close) do |_wf, io|
+      next if options.dig(:workflow, :no_email)
+      next unless session.mailer?
+      next if session.config.dry_run?
+      next unless session.config.run_mode_remote?
+      next unless some_update?(io) || error?
+
+      subject = base_subject
+
+      if session.job_groups.empty? && error?
+        subject = "#{subject} - Exception!"
+        session.mail(subject: subject, body: errors_n_warnings(io))
+      else
+        subject = "#{subject} & Errors"     if session.job_groups.errors?
+        subject = "#{subject} - Exception!" if error?
+
+        msg     = "#{session.summary}\n"
+        msg    += errors_n_warnings(io)
+
+        session.mail(subject: subject, body: msg) unless msg.strip.empty?
+      end
+    end
+  end
+
+  class << self
+    attr_accessor :error
+
+    def org_name
+      self::ORG
+    end
+
+    def base_subject
+      "#{org_name} (#{active_enviro}) at #{Time.now.iso8601}"
+    end
+
+    def some_update?(io)
+      cli.config.usecases.active(io: io).any? do |usecase, data|
+        [:transform, :sync].any? { |type| usecase.type == type }
+      end
+    end
+
+    def error?
+      !!error
+    end
+
+    def errors_n_warnings(io)
+      [error_message, log_err_n_warn(io)].join("\n")
+    end
+
+    def log_err_n_warn(io)
+      warn_errors = io.logger.cache.logs(level: [:error, :warn])
+      return if warn_errors.empty?
+      "WARNINGS & ERRORS:\n#{warn_errors.join('')}\n"
+    end
+
+    def error_message
+      error&.patch_full_message(trace_count: 3)
+    end
+
+    def trace_count
+      self::TRACE_COUNT
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+class Eco::API::Common::Loaders::Workflow < Eco::API::Common::Loaders::Config
+  class << self
+    def workflow
+      config.workflow
+    end
+  end
+
+  delegate_missing_to :workflow
+end
+
+require_relative 'workflow/mailer'

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

@@ -0,0 +1,29 @@
+class Eco::API::Common::Loaders::Config
+  extend Eco::API::Common::ClassHelpers
+  extend Eco::Language::Methods::DelegateMissing
+  inheritable_class_vars :delegate_missing_to
+
+  class << self
+    # To create samples of configurations
+    def config_block(&block)
+      return @config_block unless block_given?
+      @config_block = block
+    end
+
+    def config
+      ASSETS.config
+    end
+
+    def cli
+      ASSETS.cli
+    end
+
+    def active_enviro
+      config.active_enviro
+    end
+  end
+
+  delegate_missing_to :config
+end
+
+require_relative 'config/workflow'

data/lib/eco/api/common/loaders/error_handler.rb

@@ -3,7 +3,6 @@ module Eco
     module Common
       module Loaders
         class ErrorHandler < Eco::API::Common::Loaders::CaseBase
-
           class << self
             attr_writer :error
 
@@ -35,7 +34,6 @@ module Eco
           def error
             self.class.error
           end
-
         end
       end
     end

data/lib/eco/api/common/loaders/parser.rb

@@ -3,7 +3,6 @@ module Eco
     module Common
       module Loaders
         class Parser < Eco::API::Common::Loaders::CaseBase
-
           # Helper class to scope what required attributes it depends on
           class RequiredAttrs < Struct.new(:attr, :type, :attrs)
             def active?(*input_attrs)

data/lib/eco/api/common/loaders/policy.rb

@@ -3,7 +3,6 @@ module Eco
     module Common
       module Loaders
         class Policy < Eco::API::Common::Loaders::CaseBase
-
           def initialize(policies)
             raise "Expected Eco::API::Policies. Given #{policies.class}" unless policies.is_a?(Eco::API::Policies)
             policies.define(self.name, &self.method(:main))
@@ -17,7 +16,6 @@ module Eco
           def main(people, session, options, policy, job)
             raise "You should implement this method"
           end
-
         end
       end
     end

data/lib/eco/api/common/loaders/use_case.rb

@@ -11,9 +11,31 @@ module Eco
               end
               @type = value
             end
+
+            def cli!
+              cli&.apply!
+            end
+
+            def cli(cli_class = nil)
+              if cli_class.is_a?(Class)
+                raise ArgumentError, "cli_class should inherit from Eco::API::UseCases::Cli" unless cli_class < Eco::API::UseCases::Cli
+                @cli = cli_class
+              elsif cli_class.nil?
+                return @cli if instance_variable_defined?(:@cli) && !@cli.nil?
+                # try to see if it's namespaced after the use case it provisions cli integration
+                begin
+                  try_class = [self.to_s, 'Cli'].join('::')
+                  @cli = Kernel.const_get(try_class)
+                rescue NameError
+                  nil
+                end
+              else
+                raise ArgumentError, "Expecting a class. Given: #{cli_class.class} object"
+              end
+            end
           end
 
-          inheritable_class_vars :type
+          inheritable_class_vars :type, :cli
 
           def initialize(usecases)
             raise "Expected Eco::API::UseCases. Given #{usecases.class}" unless usecases.is_a?(Eco::API::UseCases)
@@ -33,6 +55,10 @@ module Eco
           def type
             self.class.type
           end
+
+          def cli_apply!
+            self.class.cli!
+          end
         end
       end
     end

data/lib/eco/api/common/loaders.rb

@@ -9,6 +9,7 @@ end
 
 require_relative 'loaders/base'
 require_relative 'loaders/case_base'
+require_relative 'loaders/config'
 require_relative 'loaders/use_case'
 require_relative 'loaders/policy'
 require_relative 'loaders/error_handler'

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

@@ -8,8 +8,8 @@ module Eco
           autoloads_children_of "Eco::API::Common::Loaders::Parser"
           autoload_namespace    "Eco::API::Common::People::DefaultParsers"
 
-          def initialize(*args)
-            super(*args)
+          def initialize(**kargs)
+            super(**kargs)
             define_defaults
           end
 

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

@@ -3,6 +3,7 @@ module Eco
     module Common
       module People
         class PersonEntry
+          DEBUG = false
 
           # This class is meant to provide a common interface to access entries of source data that come in different formats.
           # @note
@@ -37,6 +38,8 @@ module Eco
               @mapped_entry       = __mapped_entry(@internal_entry)
               @external_entry     = __external_entry(@mapped_entry)
             end
+
+            (print_models; exit(1)) if DEBUG
           end
 
           # Generates a new entry