eco-helpers 2.4.9 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f4b841b95f31b7f25c9b5fd33c949bedbc46f2850c0c68b863818f3c75105b1
-  data.tar.gz: 4ec1d5c2859303fa6943974d19d07c7a4391f4d76fe2a01682510a26e9f92016
+  metadata.gz: 140086432682ed765773ca3f1fabcdd46606c04507d6652d94f3df68233cc7ec
+  data.tar.gz: fb68c2d6ab307711c45660cf169303b3e79f7555eb5199a6ed33455030def28a
 SHA512:
-  metadata.gz: 84a0e4e6191ec10cf37088afce2fff53f9450b4d14f5d8c6206b152d4a0b4758127e5b8df0e3807c99c7dc99263de434fa92787baa778de9322ef56704ea9acd
-  data.tar.gz: 26b7d8b4e627c8638dd2b392063a25f4f7a633ea13ee3fe6f71bfccff81a3160cee957abc905d1f07e9f6c9e029a507e85b2f256120729fe5096fb2ea83c5018
+  metadata.gz: 96ab04ce3bdb34c994becd6a6223cbae38a95aa8bd2309906c047a39a0476b689cf76d7538556c650a826eae5f31cd807c351f0fd6f765cb5efb39857022981f
+  data.tar.gz: 0365d9f8777250747eef5580df8531bc07a77dfa7d46c7aaefd29898e44f2450f62fcad8c64f97976d1ae1f7526bfa5e8dcf34eeaa1c4d36777e3e0beff43dff

data/CHANGELOG.md

@@ -1,11 +1,40 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.4.10] - 2023-04-xx
+## [2.5.2] - 2023-06-xx
 
 ### Added
+  - `Eco::API::Session::Config::Workflow#exit_handle`
+    - Allows to define a callback on `SystemExit` (`exit` call).
+
 ### Changed
 ### Fixed
+  - `Eco::API::Session::Config::Workflow` on `SystemExit` preserve original exit `status` value (i.e. `0`, `1`)
+    - It was changing an `exit 1` to be an `exit 0`
+  - Default Workflow. `exit 0` when no operation specified (rather than `exit 1`).
+
+## [2.5.1] - 2023-06-06
+
+### Added
+  - `Eco::API::Common::Session:SFTP#host` method
+  - New options to control csv headers check (`Eco::API::Common::People::DefaultParsers::CSVParser`)
+  - `Eco::API::Common::Loaders::CaseBase` add to the setter the `@usecase`
+    - Implemented via `Eco::API::UseCases::UseCase`
+
+### Changed
+  - Dry out dependency loading.
+    - `ecoportal-api` **gem** remains as eager loading.
+  - Patch `Ecoportal::API::V1::Person` with `include`
+  - Upgraded `ecoportal-api-graphql` **gem**
+  - `Eco::API::Common::People::PersonEntryAttributeMapper`
+    - Switched reversed attr defs warning to `info` logging level.
+  - `Eco::API::Common::DefaultParsers::SelectParser`
+    - When there is dependency with the hash of options, it should return nil when the option is unknown.
+
+### Fixed
+  - Tidied up file encoding when getting content.
+    - This fixes `Eco::CSV::read`
+  - `Eco::API::Common::People::DefaultParsers::CSVParser` made some refactor.
 
 ## [2.4.9] - 2023-04-17
 

data/eco-helpers.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'ecoportal-api', '>= 0.9.4', '< 0.10'
   spec.add_dependency 'ecoportal-api-v2', '>= 1.1.2', '< 1.2'
-  spec.add_dependency 'ecoportal-api-graphql', '>= 0.3.6', '< 0.4'
+  spec.add_dependency 'ecoportal-api-graphql', '>= 0.3.7', '< 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'

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

@@ -3,7 +3,6 @@ module Eco
     module Common
       module Loaders
         class CaseBase < Loaders::Base
-
           class << self
             attr_writer :name, :type
 
@@ -19,13 +18,13 @@ module Eco
             def name_only_once!
               raise "You have already declared #{self} or you are trying to give it a name twice" if @name
             end
-
           end
 
+          attr_reader :usecase
+
           def name
             self.class.name
           end
-
         end
       end
     end

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

@@ -149,7 +149,6 @@ module Eco
           def _define_serializer(attr_parser)
             attr_parser.def_serializer(self.class.serializing_phase, &self.method(:serializer))
           end
-
         end
       end
     end

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

@@ -3,7 +3,8 @@ class Eco::API::Common::People::DefaultParsers::CSVParser < Eco::API::Common::Lo
 
   def parser(data, deps)
     Eco::CSV.parse(data, headers: true, skip_blanks: true).tap do |table|
-      check_headers(table) if deps[:check_headers] && !options.dig(:input, :skip_header_check)
+      require_headers!(table)
+      check_headers(table) if deps[:check_headers] && check_headers?
     end.each_with_object([]) do |row, arr_hash|
       row_hash = row.headers.uniq.each_with_object({}) do |attr, hash|
         next if attr.to_s.strip.empty?
@@ -26,6 +27,26 @@ class Eco::API::Common::People::DefaultParsers::CSVParser < Eco::API::Common::Lo
 
   private
 
+  def abort(message)
+    logger.error(message)
+    exit(1)
+  end
+
+  def require_headers!(table)
+    headers = table.headers
+    abort("Missing headers in CSV") unless headers && !headers.empty?
+    empty = []
+    with_value = headers.each_with_index do |header, idx|
+      empty << idx if header.to_s.strip.empty?
+    end
+    abort("Empty headers in column(s): #{empty.join(', ')}") unless empty.empty?
+    true
+  end
+
+  def check_headers?
+    !options.dig(:input, :header_check, :skip)
+  end
+
   def options
     ASSETS.cli.options
   end
@@ -43,29 +64,54 @@ class Eco::API::Common::People::DefaultParsers::CSVParser < Eco::API::Common::Lo
   end
 
   def check_headers(table)
-    headers = table.headers
-    missing = missing_headers(headers)
-    unknown = unknown_headers(headers)
-    unless missing.empty? && unknown.empty?
-      msg  = "Detected possible HEADER ISSUES !!!\n"
-      msg << "There might be Missing or Wrong HEADER names in the CSV file:\n"
-      msg << "  * UNKNOWN (or not used?): #{unknown}\n" unless unknown.empty?
-      msg << "  * MISSING DIRECT: #{missing[:direct]}\n" unless (missing[:direct] || []).empty?
-      unless (data =  missing[:indirect] || []).empty?
-        msg << "  * MISSING INDIRECT:\n"
-        data.each do |ext, info|
-          msg <<  "    - '#{ext}' => "
-          msg << (info[:attrs] || {}).map do |status, attrs|
-            if status == :inactive
-              "makes inactive: #{attrs}"
-            elsif status == :active
-              "there could be missing info in: #{attrs}"
-            end
-          end.compact.join("; ") + "\n"
-        end
+    headers  = table.headers
+    unmatch  = []
+    unmatch  = unmatched_headers(headers) if options.dig(:input, :header_check, :order)
+    missing  = missing_headers(headers)
+    unknown  = unknown_headers(headers)
+    criteria = [unknown, missing[:direct], missing[:indirect], unmatch]
+    return if criteria.all?(&:empty?)
+
+    msg  = "Detected possible HEADER ISSUES !!!\n"
+
+    # requires exact match
+    unless unmatch.empty?
+      msg << "CSV headers do NOT exactly match the expected:\n"
+      msg << "  * Expected: #{known_headers}\n"
+      expected, given = unmatch.first
+      msg << "  * First unmatch => Given: '#{given}' where expected '#{expected}'\n"
+      missed = known_headers - headers
+      unless missed.empty?
+        msg << "  * Missing headers:\n"
+        msg << "    - #{missed.join("\n    - ")}\n"
       end
-      logger.warn(msg)
-      sleep(2)
+    end
+    msg << "Missing or Wrong HEADER names in the CSV file:\n"
+    msg << "  * UNKNOWN (or not used?): #{unknown}\n" unless unknown.empty?
+    msg << "  * MISSING HEADER: #{missing[:direct]}\n" unless missing[:direct].empty?
+    unless (data = missing[:indirect]).empty?
+      msg << "  * MISSING INDIRECTLY:\n"
+      data.each do |ext, info|
+        msg <<  "    - '#{ext}' => "
+        msg << (info[:attrs] || {}).map do |status, attrs|
+          if status == :inactive
+            "makes inactive: #{attrs}"
+          elsif status == :active
+            "there could be missing info in: #{attrs}"
+          end
+        end.compact.join("; ") + "\n"
+      end
+    end
+    logger.warn(msg)
+    if options.dig(:input, :header_check, :must_be_valid)
+      abort("There were issues identified on the CSV header names. Aborting...")
+    end
+    sleep(2)
+  end
+
+  def unmatched_headers(headers)
+    known_headers.zip(headers).reject do |(expected, given)|
+      expected == given
     end
   end
 
@@ -82,27 +128,28 @@ class Eco::API::Common::People::DefaultParsers::CSVParser < Eco::API::Common::Lo
     ext_present = known_headers_present(int_head) | ext
     ext_miss    = known_headers - ext_present
 
-    ext_miss.each_with_object({}) do |ext, missing|
-      next unless int = fields_mapper.to_internal(ext)
-      if all_internal_attrs.include?(int)
-        missing[:direct] ||= []
-        missing[:direct] << ext
-      end
-      related_attrs_requirements = required_attrs.values.select do |req|
-        dep       = req.dependant?(int)
-        affects   = dep && !int_head.include?(int)
-        in_header = int_head.include?(req.attr)
-        affects || (dep && !in_header)
-      end
-      next if related_attrs_requirements.empty?
-      missing[:indirect] ||= {}
-      data = missing[:indirect][ext] = {}
-      data[:int]   = int
-      data[:attrs] = {}
-      related_attrs_requirements.each_with_object(data[:attrs]) do |req, attrs|
-        status = req.active?(*int_head) ? :active : :inactive
-        attrs[status] ||= []
-        attrs[status] << req.attr
+    {
+      direct:   [],
+      indirect: {}
+    }.tap do |missing|
+      ext_miss.each do |ext|
+        next unless int = fields_mapper.to_internal(ext)
+        missing[:direct] << ext if all_internal_attrs.include?(int)
+        related_attrs_requirements = required_attrs.values.select do |req|
+          dep       = req.dependant?(int)
+          affects   = dep && !int_head.include?(int)
+          in_header = int_head.include?(req.attr)
+          affects || (dep && !in_header)
+        end
+        next if related_attrs_requirements.empty?
+        data = missing[:indirect][ext] = {}
+        data[:int]   = int
+        data[:attrs] = {}
+        related_attrs_requirements.each_with_object(data[:attrs]) do |req, attrs|
+          status = req.active?(*int_head) ? :active : :inactive
+          attrs[status] ||= []
+          attrs[status] << req.attr
+        end
       end
     end
   end
@@ -114,8 +161,11 @@ class Eco::API::Common::People::DefaultParsers::CSVParser < Eco::API::Common::Lo
     end
   end
 
+  # Scopes what internal attrs appear in headers as they are
   def internal_present_or_active(headers, inactive_requirements = {})
-    hint = headers & all_internal_attrs
+    # internal attrs that are not being mapped
+    int_all = all_internal_attrs.reject {|i| fields_mapper.external?(i)}
+    hint = headers & int_all
     hext = headers - hint
     int_present = hint + hext.map {|e| fields_mapper.to_internal(e)}.compact
 
@@ -142,8 +192,9 @@ class Eco::API::Common::People::DefaultParsers::CSVParser < Eco::API::Common::Lo
     int_present
   end
 
+  # The csv header names as expected
   def known_headers
-    @known_headers ||= fields_mapper.list(:external).compact
+    @known_headers ||= fields_mapper.list(:external).compact.uniq
   end
 
   def fields_mapper
@@ -167,5 +218,4 @@ class Eco::API::Common::People::DefaultParsers::CSVParser < Eco::API::Common::Lo
   def person_parser
     session.entry_factory.person_parser
   end
-
 end

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

@@ -11,9 +11,9 @@ module Eco
                   options_hash = deps[:select_hashes][deps["attr"]]
                   next value if !options_hash
                   if value.is_a?(Array)
-                    value.map { |v| options_hash[v&.downcase.strip] || v }
+                    value.map { |v| options_hash[v&.downcase.strip]  }.compact
                   elsif value
-                    options_hash[value&.downcase.strip] || value
+                    options_hash[value&.downcase.strip]
                   end
                 end.def_serializer do |value|
                   value

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

@@ -64,5 +64,4 @@ class Eco::API::Common::People::DefaultParsers::XLSParser < Eco::API::Common::Lo
     require 'roo-xls'
     already_required = true
   end
-
 end

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

@@ -86,10 +86,10 @@ module Eco
           # @option options [Boolean] :check_headers signals if the `csv` file headers should be expected.
           # @return [Eco::API::Common::People::Entries] collection of `Eco::API::Common::People::PersonEntry`.
           def entries(data: (no_data = true; nil), file: (no_file = true; nil), format: (no_format = true; nil), **options)
-            fatal("You should at least use data: or file:, but not both") if no_data == no_file
+            fatal("You should at least use data: or file:, but not both")         if no_data == no_file
             fatal("You must specify a valid format: (symbol) when you use file.") if file && no_format
-            fatal("Format should be a Symbol. Given '#{format}'") if format && !format.is_a?(Symbol)
-            fatal("There is no parser/serializer for format ':#{format.to_s}'") unless no_format || @person_parser.defined?(format)
+            fatal("Format should be a Symbol. Given '#{format}'")                 if format && !format.is_a?(Symbol)
+            fatal("There is no parser/serializer for format ':#{format.to_s}'")   unless no_format || @person_parser.defined?(format)
 
             options.merge!(content:  data)     unless no_data
             options.merge!(file:     file)     unless no_file
@@ -113,9 +113,8 @@ module Eco
             # Get content only when it's not :xls
             # note: even if content was provided, file takes precedence
             if (format != :xls) && file
-              content = get_file_content(file, encoding)
+              content = get_file_content(file, encoding: encoding)
             end
-            #content = get_file_content(file, format, encoding) if (format != :xls) && file
 
             case content
             when Hash
@@ -129,15 +128,16 @@ module Eco
               case sample
               when Hash, Array, ::CSV::Row
                 Eco::CSV::Table.new(content).to_array_of_hashes
+              when NilClass
+                abort("There is NO input data")
               else
-                logger.error("Input content 'Array' of '#{sample.class}' is not supported.")
+                abort("Input content 'Array' of '#{sample.class}' is not supported.")
               end
             else
               if file && format == :xls
                 person_parser.parse(format, file)
               else
-                logger.error("Could not obtain any data out of these: #{kargs}. Given content: '#{content.class}'")
-                exit(1)
+                abort("Could not obtain any data out of these: #{kargs}. Given content: '#{content.class}'")
               end
             end.tap do |out_array|
               start_from_two = (format == :csv) || format == :xls
@@ -189,6 +189,11 @@ module Eco
 
           private
 
+          def abort(message)
+            logger.error(message)
+            exit(1)
+          end
+
           def fatal(msg)
             logger.fatal(msg)
             raise msg

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

@@ -133,7 +133,7 @@ module Eco
                 attr = @attr_map.to_internal(value.strip)
               when @attr_map.internal?(value) || @attr_map.internal?(value.strip) || @attr_map.internal?(value.strip.downcase)
                 unless cached_warning("external", "reversed", value)
-                  logger.warn("The mapper [external, internal] attribute names may be declared reversedly for EXTERNAL attribute: '#{value}'")
+                  logger.info("The mapper [external, internal] attribute names may be declared reversedly for EXTERNAL attribute: '#{value}'")
                 end
               end
             end
@@ -172,7 +172,7 @@ module Eco
                 attr = @attr_map.to_external(value.strip)
               when @attr_map.external?(value) || @attr_map.external?(value.strip) || @attr_map.external?(value.strip.downcase)
                 unless cached_warning("internal", "reversed", value)
-                  logger.warn("The mapper [external, internal] attribute names may be declared reversedly for INTERNAL attribute: '#{value}'")
+                  logger.info("The mapper [external, internal] attribute names may be declared reversedly for INTERNAL attribute: '#{value}'")
                 end
               end
             end

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

@@ -12,7 +12,7 @@ module Eco
           alias_method :fm, :file_manager
 
           include Session::Helpers
-          
+
           def initialize(e)
             raise "Expected object Eco::API::Common::Session::Environment. Given: #{e.class}" unless e.is_a?(Environment)
             self.environment = e
@@ -72,7 +72,6 @@ module Eco
             logger.fatal(msg)
             raise msg
           end
-
         end
       end
     end

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

@@ -24,9 +24,8 @@ module Eco
           end
 
           def mailer
-            if mailer?
-              @mailer      ||= Eco::API::Common::Session::Mailer.new(enviro: self)
-            end
+            return nil unless mailer?
+            @mailer ||= Eco::API::Common::Session::Mailer.new(enviro: self)
           end
 
           def mailer?
@@ -34,9 +33,8 @@ module Eco
           end
 
           def sftp
-            if sftp?
-              @sftp        ||= Eco::API::Common::Session::SFTP.new(enviro: self)
-            end
+            return nil unless sftp?
+            @sftp ||= Eco::API::Common::Session::SFTP.new(enviro: self)
           end
 
           def sftp?
@@ -44,9 +42,8 @@ module Eco
           end
 
           def s3uploader
-            if s3uploader?
-              @s3uploader  ||= Eco::API::Common::Session::S3Uploader.new(enviro: self)
-            end
+            return nil unless s3uploader?
+            @s3uploader  ||= Eco::API::Common::Session::S3Uploader.new(enviro: self)
           end
 
           def s3uploader?
@@ -56,7 +53,6 @@ module Eco
           def api(version: nil)
             config.api(logger, version: version)
           end
-
         end
       end
     end

data/lib/eco/api/common/session/helpers/prompt_user.rb

@@ -1,31 +1,31 @@
-require 'timeout'
 module Eco
   module API
     module Common
       module Session
         module Helpers
           module PromptUser
-
+            # Prompts user for input with option for default on timeout.
             def prompt_user(question, default:, explanation: "", timeout: nil)
-              response = if config.run_mode_remote?
-                          default
-                        else
-                          puts explanation
-                          print "#{question} "
-                          if timeout
-                            begin
-                              Timeout::timeout(timeout) { STDIN.gets.chop }
-                            rescue Timeout::Error
-                              default
-                            end
-                          else
-                            STDIN.gets.chop
-                          end
-                        end
+              require 'timeout'
+              response = \
+                if config.run_mode_remote?
+                  default
+                else
+                  puts explanation
+                  print "#{question} "
+                  if timeout
+                    begin
+                      Timeout::timeout(timeout) { STDIN.gets.chop }
+                    rescue Timeout::Error
+                      default
+                    end
+                  else
+                    STDIN.gets.chop
+                  end
+                end
               return response unless block_given?
               yield(response)
             end
-
           end
         end
       end

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

@@ -1,5 +1,3 @@
-require 'aws-sdk-ses'
-
 module Eco
   module API
     module Common
@@ -42,6 +40,7 @@ module Eco
           private
 
           def ses
+            require 'aws-sdk-ses'
             begin
               @ses ||= Aws::SES::Client.new(
                 access_key_id:     fetch_access_key_id,
@@ -98,7 +97,6 @@ module Eco
           def fetch_message_id_domain
             config.mailer.message_id_domain
           end
-
         end
       end
     end

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

@@ -1,5 +1,3 @@
-require 'aws-sdk-s3'
-
 module Eco
   module API
     module Common
@@ -75,6 +73,7 @@ module Eco
           end
 
           def bucket
+            require 'aws-sdk-s3'
             begin
               @bucket ||= Aws::S3::Resource.new(
                 access_key_id:     fetch_access_key_id,
@@ -128,7 +127,6 @@ module Eco
           def fetch_region
             config.s3storage.region || ENV['AWS_REGION']
           end
-
         end
       end
     end

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

@@ -1,20 +1,23 @@
-require "net/sftp"
 module Eco
   module API
     module Common
       module Session
         class SFTP
-
           def initialize (enviro:)
             raise "Required Environment object (enviro:). Given: #{enviro}" if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
             @enviro = enviro
           end
 
+          def host
+            @host ||= fetch_host
+          end
+
           # @see Net::SFTP::Session
           def sftp_session
+            require "net/sftp"
             begin
               @sftp_session ||= Net::SFTP.start(
-                fetch_host,
+                host,
                 fetch_user,
                 **session_options
               )
@@ -135,7 +138,6 @@ module Eco
           def fetch_base_path
             config.sftp.base_path || ENV['SFTP_BASE_PATH']
           end
-
         end
       end
     end

data/lib/eco/api/common/version_patches/ecoportal_api/external_person.rb

@@ -1,8 +1,8 @@
-module Ecoportal
+module Eco
   module API
-    class V1
-      # @attr entry [Eco::API::Common::People::PersonEntry, Hash] the input entry plain hash data used to update/create this person.
-      class Person
+    module Common
+      module PersonPatch
+        # @attr entry [Eco::API::Common::People::PersonEntry, Hash] the input entry plain hash data used to update/create this person.
         attr_accessor :entry
 
         def identify(section = :person)
@@ -14,6 +14,7 @@ module Ecoportal
           end
         end
       end
+      Ecoportal::API::V1::Person.include PersonPatch
     end
   end
 end

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

@@ -24,8 +24,10 @@ module Eco
               when :v1
                 Ecoportal::API::V1
               when :v2
+                require 'ecoportal/api-v2'
                 Ecoportal::API::V2
               when :graphql
+                require 'ecoportal/api-graphql'
                 Ecoportal::API::GraphQL
               else
               end
@@ -45,8 +47,8 @@ module Eco
             self["mode"]         = mode
             self["user_key"]     = user_key
             self["external_key"] = external_key
-            self["email"]        = email
-            self["pass"]         = pass
+            self["email"]        = email || ENV['USER_EMAIL']
+            self["pass"]         = pass  || ENV['USER_PASS']
             self["org_id"]       = org_id
           end
 

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

@@ -129,6 +129,12 @@ module Eco
             self
           end
 
+          def exit_handle(&block)
+            return @exit_handle unless block
+            @exit_handle = block
+            self
+          end
+
           # Used in **configuration** time **add previous** `callbacks` **before** the `on` _callback_ of the (sub)stage `key` is actually `run`
           # @note
           #   - it will **not** `yield` it immediately, but when the _workflow_ reaches the target stage
@@ -239,8 +245,9 @@ module Eco
                   end
                 end
               end
-            rescue SystemExit
-              exit
+            rescue SystemExit => e
+              self.exit_handle.call(e, io) if self.exit_handle
+              exit e.status
             rescue Interrupt => i
               raise
             rescue Exception => e

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

@@ -3,7 +3,6 @@ module Eco
     class UseCases
       # Core class of UseCases. It basically defines and manages allowed `types`
       class BaseCase
-
         class InvalidType < StandardError
           def initialize(msg = nil, type:, types:)
             msg ||= "Invalid type."
@@ -27,7 +26,6 @@ module Eco
             raise InvalidType.new(type: type, types: types) unless valid_type?(type)
           end
         end
-
       end
     end
   end