eco-helpers 2.4.8 → 2.5.1

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/error.rb

@@ -4,7 +4,7 @@ module Eco
     class Error < StandardError
       class UnknownErrorClass < StandardError
         def initialize(msg = nil, klass:)
-          msg ||= "Unkown api error class #{klass}"
+          msg ||= "Unknown api error class #{klass}"
           super(msg)
         end
       end
@@ -60,19 +60,19 @@ module Eco
         @str_err = "Invalid ObjectId."
         @match   = /'(.*?)' is an invalid ObjectId./
       end
-      class UnkownField < Eco::API::Error
+      class UnknownField < Eco::API::Error
         @str_err = "Unknown field."
         @match   = /(.+?) is an unknown field/
 
-        class UnkownCoreField < UnkownField
+        class UnknownCoreField < UnknownField
           @str_err = "Unknown core field."
           @match   = /(.+?) is an unknown field/
         end
-        class UnkownAccountField < UnkownField
+        class UnknownAccountField < UnknownField
           @str_err = "Unknown account field."
           @match   = /account \> (.+?) is an unknown field/
         end
-        class UnkownDetailsField < UnkownField
+        class UnknownDetailsField < UnknownField
           @str_err = "Unknown details field."
           @match   = /details \> (.+?) is an unknown field/
         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/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

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

@@ -26,7 +26,6 @@ module Eco
           def people_required?(type)
             !valid_type?(type) || [:filter, :transform, :sync, :error_handler, :export].include?(type)
           end
-
         end
 
         attr_reader   :input, :people, :session, :options
@@ -111,9 +110,7 @@ module Eco
         def people_required?
           self.class.people_required?(type)
         end
-
       end
-
     end
   end
 end

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

@@ -47,7 +47,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
   end
 
   def list_folder
-    puts "Listing remote folder: '#{remote_folder}':"
+    puts "Listing remote folder: '#{remote_folder}' (host: #{sftp.host}):"
     with_remote_files {|file| puts file.longname}
   end
 

data/lib/eco/api/usecases/ooze_samples/ooze_from_doc_case.rb

@@ -1,4 +1,3 @@
-require 'docx'
 # Use case to abstract FORM from word document
 class Eco::API::UseCases::OozeSamples::OozeFromDocCase < Eco::API::UseCases::OozeSamples::OozeUpdateCase
   name "ooze-forms-case"
@@ -34,11 +33,11 @@ class Eco::API::UseCases::OozeSamples::OozeFromDocCase < Eco::API::UseCases::Ooz
   end
 
   def doc
+    require 'docx'
     @doc ||= Docx::Document.open(input_file)
   end
 
   def input_file
     options.dig(:source, :file)
   end
-
 end

data/lib/eco/api/usecases/ooze_samples/ooze_run_base_case.rb

@@ -58,5 +58,4 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::UseCases::Ooz
       exit(1) unless response.upcase.start_with?("Y")
     end
   end
-
 end

data/lib/eco/api/usecases/ooze_samples/ooze_update_case.rb

@@ -11,5 +11,4 @@ class Eco::API::UseCases::OozeSamples::OozeUpdateCase < Eco::API::UseCases::Ooze
     fld ||= target.components.select {|fld| same_name?(fld.label, value)}
     #fld ||= value.reference if value.is_a?(Ecoportal::API::V2::Page::Force::Binding)
   end
-
 end

data/lib/eco/api/usecases/ooze_samples/register_export_case.rb

@@ -4,7 +4,6 @@
 #   - You need to define the `process_ooze` method
 # This case expects `options[:source][:register_id]`
 class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Loaders::UseCase
-
   class << self
     # @return [Integer] the number of pages to be processed in each batch
     def batch_size(size = nil)
@@ -27,6 +26,7 @@ class Eco::API::UseCases::OozeSamples::RegisterExportCase < Eco::API::Common::Lo
     @session = session; @options = options; @usecase = usecase
     @target  = nil
     raise "You need to inherit from this class ('#{self.class}') and call super with a block" unless block_given?
+
     with_each_entry do |ooze|
       process_ooze(ooze)
     end

data/lib/eco/api/usecases/ooze_samples/register_update_case.rb

@@ -4,7 +4,6 @@
 #   - You need to define the `process_ooze` method
 # This case expects `options[:source][:register_id]`
 class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::OozeSamples::OozeBaseCase
-
   class << self
     # @return [Integer] the number of pages to be processed in each batch
     def batch_size(size = nil)
@@ -236,5 +235,4 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
   def register_id
     options.dig(:source, :register_id)
   end
-
 end

data/lib/eco/api/usecases/ooze_samples/target_oozes_update_case.rb

@@ -60,5 +60,4 @@ class Eco::API::UseCases::OozeSamples::TargetOozesUpdateCase < Eco::API::UseCase
   def input_csv
     @input_csv ||= Eco::CSV.read(options.dig(:source, :file))
   end
-
 end

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

@@ -2,7 +2,6 @@ module Eco
   module API
     class UseCases
       class OozeSamples
-
       end
     end
   end

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

@@ -17,6 +17,11 @@ module Eco
           @times_launched = 0
         end
 
+        def source_object
+          return nil unless callback_from_loader?
+          callback_self
+        end
+
         def chainer
           # TODO: root is a Eco::API::UseCases that will not point to this new case.
           # => Moreover, the name and type will be the same as self
@@ -42,6 +47,7 @@ module Eco
           UseCaseIO.new(**kargs).tap do |uio|
             @options   = uio.options
             uio.session.logger.debug("#{self.class}: going to process '#{name}'")
+            set_session_n_options(session: uio.session, options: uio.options) if callback_from_loader?
             uio.output = @callback.call(*uio.params)
             @times_launched += 1
           end
@@ -53,8 +59,31 @@ module Eco
           @callback
         end
 
-      end
+        def callback_self
+          eval("self", @callback.binding)
+        end
 
+        def callback_from_loader?
+          callback_self.is_a?(Eco::API::Common::Loaders::Base)
+        end
+
+        # Set the instance variables `@session` and `@options`
+        # in the use case definition
+        # @note this only works when the use case was defined
+        #   via an children class of `Eco::API::Common::Loaders::Base`
+        def set_session_n_options(session:, options: @options)
+          return false unless callback_from_loader?
+          use_case_self = self
+          callback_self.instance_eval do
+            next unless self.is_a?(Eco::API::Common::Loaders::CaseBase)
+            # `self` is the use case itself (when used the Loader)
+            @session = session
+            @options = options
+            @usecase = use_case_self
+          end
+          true
+        end
+      end
     end
   end
 end

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

@@ -3,8 +3,7 @@ module Eco
     class UseCases
       # Class that enables to chain multiple UseCase
       class UseCaseChain < UseCase
-        @types  = UseCase.types
-
+        @types       = UseCase.types
         MAX_CHAINS   = 70
         @@num_chains = 0
 
@@ -86,9 +85,7 @@ module Eco
             usecase
           end
         end
-
       end
-
     end
   end
 end

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

@@ -1,7 +1,6 @@
 module Eco
   module API
     class UseCases
-
       # InputOutput class for usecases.
       # @note Same as Eco::API::UseCases::BaseIO but:
       #  - includes `type` of usecase
@@ -76,7 +75,6 @@ module Eco
           self.class.new(**kargs)
         end
       end
-
     end
   end
 end

data/lib/eco/api/usecases.rb

@@ -2,9 +2,9 @@ module Eco
   module API
     class UseCases
 
-      class UnkownCase < StandardError
+      class UnknownCase < StandardError
         def initialize(msg = nil, case_name: nil, type: nil)
-          msg ||= "Unkown case"
+          msg ||= "Unknown case"
           msg += ". Case name '#{case_name}'" if case_name
           msg += ". Case type '#{type}'" if type
           super(msg)
@@ -112,9 +112,9 @@ module Eco
         if type && target_case = to_h[key(name, type)]
           return target_case
         elsif type
-          raise UseCases::UnkownCase.new(case_name: name, type: type)
+          raise UseCases::UnknownCase.new(case_name: name, type: type)
         end
-        raise UseCases::UnkownCase.new(case_name: name, type: type) unless cases = by_name[name]
+        raise UseCases::UnknownCase.new(case_name: name, type: type) unless cases = by_name[name]
         raise UseCases::AmbiguousCaseReference.new(case_name: name) if cases.length > 1
         cases.first
       end

data/lib/eco/api.rb

@@ -1,6 +1,4 @@
 require 'ecoportal/api'
-require 'ecoportal/api-v2'
-require 'ecoportal/api-graphql'
 
 module Eco
   module API

data/lib/eco/cli/config/default/options.rb

@@ -42,7 +42,17 @@ ASSETS.cli.config do |cnf|
 
     desc = "Skips the check of the headers"
     options_set.add("-skip-header-check", desc) do |options, session|
-      options.deep_merge!(input: {skip_header_check: true})
+      options.deep_merge!(input: {header_check: {skip: true}})
+    end
+
+    desc = "It requires the order of the headers to be as expected (exact match required)"
+    options_set.add("-header-order-check", desc) do |options, session|
+      options.deep_merge!(input: {header_check: {order: true}})
+    end
+
+    desc = "It raises an exception if any header issues are detected"
+    options_set.add("-require-valid-header", desc) do |options, session|
+      options.deep_merge!(input: {header_check: {must_be_valid: true}})
     end
 
     desc = "Fix the current session to work with this schema"

data/lib/eco/cli/scripting/arguments.rb

@@ -46,7 +46,7 @@ module Eco
           end
         end
 
-        def any_unkown?(exclude: [])
+        def any_unknown?(exclude: [])
           unknown(exclude: exclude).length > 0
         end
 

data/lib/eco/csv.rb

@@ -1,9 +1,8 @@
 require 'csv'
-
 module Eco
   class CSV < ::CSV
-
     class << self
+      include Eco::Data::Files
 
       # @return [Eco::CSV::Table]
       def parse(data, **kargs, &block)
@@ -13,12 +12,10 @@ module Eco
 
       # @return [Eco::CSV::Table]
       def read(file, **kargs)
-        kargs = {headers: true,  skip_blanks: true}.merge(kargs)
-        args = [file].tap do |arg|
-          encoding = Eco::API::Common::Session::FileManager.encoding(file)
-          arg.push("rb:bom|utf-8") if encoding == "bom"
+        params = {}.tap do |prms|
+          prms.merge!(encoding: kargs.delete(:encoding)) if kargs.key?(:encoding)
         end
-        Eco::CSV::Table.new(super(*args, **kargs))
+        parse(get_file_content(file, **params), **kargs)
       end
     end
   end

data/lib/eco/data/files/directory.rb

@@ -1,10 +1,7 @@
-#require 'fileutils'
-
 module Eco
   module Data
     module Files
       class Directory
-
         class << self
           def create(path, includes_file: false)
             return true if Files.file_exists?(path)

data/lib/eco/data/files/encoding.rb

@@ -0,0 +1,75 @@
+module Eco
+  module Data
+    module Files
+      module Encoding
+        include Eco::Language::AuxiliarLogger
+
+        BOM_BYTES = [239, 187, 191]
+
+        def has_bom?(path)
+          return false if !path || file_empty?(path)
+          File.open(path, "rb") do |f|
+            bytes = f.read(3)
+            return bytes.unpack('C*') == BOM_BYTES
+          end
+        end
+
+        def get_file_content_with_encoding(file, encoding: nil)
+          encoding ||= scoped_encoding(file)
+          unless !encoding || encoding == 'utf-8'
+            msg = "File encoding: '#{encoding}'"
+            logger.debug(msg)
+            puts msg
+          end
+
+          bom_enc = encoding && encoding.split('|')[0] == 'bom'
+          if has_bom?(file) || bom_enc
+            content  = remove_bom(File.read(file, encoding: 'utf-8'))
+            encoding = 'utf-8'
+          else
+            content = File.read(file, encoding: encoding)
+          end
+          return nil unless content
+          content = content.encode("utf-8") unless encoding.include?('utf-8')
+          content
+        end
+
+        # Changes encoding from bom to utf8
+        # https://stackoverflow.com/a/24916365/4352306
+        def remove_bom(content)
+          if content.bytes[0..2] == BOM_BYTES
+            bom     = BOM_BYTES.pack('C*').force_encoding('utf-8').encode('utf-8')
+            content = content.sub(bom, '')
+            content.force_encoding('utf-8')
+          end
+          content
+        end
+
+        def encoding(path)
+          has_bom?(path) ? "bom" : "utf-8"
+        end
+
+        # Gives the parameter as it should
+        def scoped_encoding(path)
+          unless file_exists?(path)
+            logger.error("File does not exist: #{path}")
+            return nil
+          end
+          encoding ||= encoding(path)
+          encoding   = (encoding == "bom") ? "#{encoding}|utf-8": encoding
+          encoding
+        end
+
+        def file_exists?(file)
+          return false if !file
+          return File.exists?(file) || File.exists?(File.expand_path(file))
+        end
+
+        def file_empty?(path)
+          return true if !File.file?(path)
+          File.zero?(path)
+        end
+      end
+    end
+  end
+end

data/lib/eco/data/files/helpers.rb

@@ -12,44 +12,34 @@ module Eco
 
       module InstanceMethods
         include Eco::Language::AuxiliarLogger
+        include Eco::Data::Files::Encoding
 
         # It offers a resilient way to read content from a file
         # @tolerance [Integer] the number of allowed encoding errors.
         # @return [String] the content of the file
-        def get_file_content(file, encoding, tolerance: 5)
-          unless self.class.file_exists?(file)
-            logger.error("File does not exist: #{file}")
-            exit(1)
-          end
-          encoding ||= self.class.encoding(file)
-          encoding   = (encoding == "bom") ? "#{encoding}|utf-8": encoding
-          unless !encoding || encoding == 'utf-8'
-            msg = "File encoding: '#{encoding}'"
-            logger.debug(msg)
-            puts msg
-          end
+        def get_file_content(file, encoding: nil, tolerance: 5)
           read_with_tolerance(file, encoding: encoding, tolerance: tolerance)
         end
 
         def read_with_tolerance(file, encoding:, tolerance: 5)
-          if content = File.read(file, encoding: encoding)
-            content = content.encode("utf-8") unless encoding.include?('utf-8')
-            content.scrub do |bytes|
-              replacement = '<' + bytes.unpack('H*')[0] + '>'
-              if tolerance <= 0
-                logger.error("There were more than 5 encoding errors in the file '#{file}'.")
-                return content
-              else
-                tolerance -= 1
-                logger.error("Encoding problem in file '#{file}': '#{replacement}'.")
-                replacement
-              end
+          return nil unless content = get_file_content_with_encoding(file, encoding: encoding)
+          content.scrub do |bytes|
+            replacement = '<' + bytes.unpack('H*')[0] + '>'
+            if tolerance <= 0
+              logger.error("There were more than 5 encoding errors in the file '#{file}'.")
+              return content
+            else
+              tolerance -= 1
+              logger.error("Encoding problem in file '#{file}': '#{replacement}'.")
+              replacement
             end
           end
         end
       end
 
       module ClassMethods
+        include Eco::Data::Files::Encoding
+
         def create_directory(path, includes_file: false)
           Directory.create(path, includes_file: includes_file)
         end
@@ -104,18 +94,6 @@ module Eco
           File.zero?(path)
         end
 
-        def has_bom?(path)
-          return false if !path || file_empty?(path)
-          File.open(path, "rb") do |f|
-            bytes = f.read(3)
-            return bytes.unpack("C*") == [239, 187, 191]
-          end
-        end
-
-        def encoding(path)
-          has_bom?(path) ? "bom" : "utf-8"
-        end
-
         def script_subfolder
           basename = File.basename($0, File.extname($0))
           path = File.dirname($0)
@@ -137,7 +115,7 @@ module Eco
 
         def csv_files(folder = ".", regexp: nil, older_than: nil)
           folder_files(folder, "*.csv", regexp: regexp, older_than: older_than).sort
-        end        
+        end
       end
 
       class << self

data/lib/eco/data/files.rb

@@ -5,6 +5,7 @@ module Eco
   end
 end
 
+require_relative 'files/encoding'
 require_relative 'files/helpers'
 require_relative 'files/file_pattern'
 require_relative 'files/directory'

data/lib/eco/data/fuzzy_match.rb

@@ -1,7 +1,3 @@
-require 'fuzzy_match'
-require 'amatch'
-require 'jaro_winkler'
-
 require_relative 'fuzzy_match/stop_words'
 require_relative 'fuzzy_match/array_helpers'
 require_relative 'fuzzy_match/string_helpers'
@@ -33,6 +29,8 @@ module Eco
             ignore_case: true,
             weight:      0.25
           }.merge(options)
+
+          require 'jaro_winkler'
           JaroWinkler.distance(str1, str2, **options)
         end
 
@@ -63,7 +61,10 @@ module Eco
             return @fuzzy_match if fuzzy_match_options == fuzzy_match_options(options)
           end
           @fuzzy_options = options
+
           # make it run with a native C extension (for better performance: ~130 % increase of performance)
+          require 'fuzzy_match'
+          require 'amatch'
           ::FuzzyMatch.engine = :amatch
           @fuzzy_match = ::FuzzyMatch.new(haystack(haystack_data), fuzzy_match_options)
         end
@@ -115,7 +116,10 @@ module Eco
               end
             end
 
+            require 'fuzzy_match'
+            require 'amatch'
             res          = ::FuzzyMatch.score_class.new(nstr, istr) unless dice && lev
+            
             dice       ||= res&.dices_coefficient_similar || 0
             lev        ||= res&.levenshtein_similar       || 0
             jaro_res   ||= jaro(nstr, istr)

data/lib/eco/data.rb

@@ -3,7 +3,6 @@ module Eco
   end
 end
 
-require_relative 'data/crypto'
 require_relative 'data/files'
 require_relative 'data/mapper'
 require_relative 'data/fuzzy_match'

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.4.8"
+  VERSION = "2.5.1"
 end

data/lib/eco-helpers.rb

@@ -8,10 +8,10 @@ require 'dotenv/load'
 module Eco
 end
 
-require_relative 'eco/csv'
 require_relative 'eco/language'
 require_relative 'eco/common'
 require_relative 'eco/data'
+require_relative 'eco/csv'
 require_relative 'eco/api'
 require_relative 'eco/cli'
 require_relative 'eco/assets'