eco-helpers 3.0.26 → 3.0.28

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

@@ -16,7 +16,7 @@ module Eco
             # @param candiates [Array<PersonEntry>] the entries that match the same search criterion.
             # @param property [String] the property of the entry model that triggered the error
             #   (base of the search criterion).
-            def initialize(msg, candidates: [], property: "email")
+            def initialize(msg, candidates: [], property: 'email')
               @candidates = candidates
               @property   = property
               super("#{msg} #{candidates_summary}")
@@ -26,7 +26,7 @@ module Eco
             # @return [Array<String>] the `candidates` identified
             def identify_candidates(with_index: false)
               candidates.map.each_with_index do |entry, i|
-                index = with_index ? "#{i}. " : ""
+                index = with_index ? "#{i}. " : ''
                 "#{index} #{entry.identify}"
               end
             end
@@ -50,7 +50,8 @@ module Eco
           alias_method :entries, :to_a
 
           def initialize(data = [], klass:, factory:)
-            super(data, klass: klass, factory: factory)
+            super
+
             @caches_init = false
           end
 
@@ -72,19 +73,19 @@ module Eco
           # @!group Special filters
 
           def filter_tags_any(tags)
-            attr("filter_tags", tags, default_modifier.any.insensitive)
+            attr('filter_tags', tags, default_modifier.any.insensitive)
           end
 
           def filter_tags_all(tags)
-            attr("filter_tags", tags, default_modifier.all.insensitive)
+            attr('filter_tags', tags, default_modifier.all.insensitive)
           end
 
           def policy_group_ids_any(ids)
-            attr("policy_group_ids", ids, default_modifier.any.insensitive)
+            attr('policy_group_ids', ids, default_modifier.any.insensitive)
           end
 
           def policy_group_ids_all(ids)
-            attr("policy_group_ids", ids, default_modifier.all.insensitive)
+            attr('policy_group_ids', ids, default_modifier.all.insensitive)
           end
           # @!endgroup
 
@@ -125,9 +126,9 @@ module Eco
           # Search function to find an `entry` based on one of different options
           # see Eco::API::Common::People::Entries#entry
           def find(object, strict: false)
-            id          = attr_value(object, "id")
-            external_id = attr_value(object, "external_id")
-            email       = attr_value(object, "email")
+            id          = attr_value(object, 'id')
+            external_id = attr_value(object, 'external_id')
+            email       = attr_value(object, 'email')
             entry(id: id, external_id: external_id, email: email, strict: strict)
           end
           # @!endgroup
@@ -159,7 +160,7 @@ module Eco
             header = each_with_object([]) do |entry, hds|
               hds.push(*entry.internal_entry.keys).uniq!
             end
-            CSV.open(filename, "w") do |csv|
+            CSV.open(filename, 'w') do |csv|
               csv << header
               each do |entry|
                 csv << entry.internal_entry.values_at(*header)
@@ -177,8 +178,8 @@ module Eco
             to_h(:supervisor_id)
           end
 
-          def to_h(attr = "id")
-            super(attr || "id")
+          def to_h(attr = 'id')
+            super(attr || 'id')
           end
           # @!endgroup
 
@@ -197,8 +198,8 @@ module Eco
             return candidates.first if candidates.length == 1
 
             if prevent_multiple_match && !candidates.empty?
-              msg = "Multiple search results match the criteria."
-              raise MultipleSearchResults.new(msg, candidates: candidates, property: "email")
+              msg = 'Multiple search results match the criteria.'
+              raise MultipleSearchResults.new(msg, candidates: candidates, property: 'email')
             end
 
             @by_external_id[email]&.first

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

@@ -108,86 +108,102 @@ module Eco
           # @note `Eco::API::Common::People::EntryFactory#entries` adds this `idx` (i.e. row number)
           # @return [Integer] the entry number in the input file
           def idx
-            final_entry["idx"]
+            final_entry['idx']
           end
 
           # @return [String, nil] the _internal id_ of this person if defined.
           def id
-            final_entry["id"]
+            final_entry['id']
           end
 
           def id?
-            final_entry.key?("id")
+            final_entry.key?('id')
           end
 
           # @return [String, nil] the _external id_ of this person if defined.
           def external_id
-            final_entry["external_id"]
+            final_entry['external_id']
           end
 
           def external_id?
-            final_entry.key?("external_id")
+            final_entry.key?('external_id')
+          end
+
+          def archived
+            final_entry['archived']
+          end
+
+          def archived_flag?
+            final_entry.key?('archived')
           end
 
           # @return [String, nil] the _name_ of this person if defined.
           def name
-            final_entry["name"]
+            final_entry['name']
           end
 
           def name?
-            final_entry.key?("name")
+            final_entry.key?('name')
           end
 
           # @return [String, nil] the _email_ of this person if defined.
           def email
-            final_entry["email"]
+            final_entry['email']
           end
 
           def email?
-            final_entry.key?("email")
+            final_entry.key?('email')
           end
 
           # @return [String, nil] the _supervisor id_ of this person if defined.
           def supervisor_id
-            final_entry["supervisor_id"]
+            final_entry['supervisor_id']
           end
 
           def supervisor_id=(value)
-            final_entry["supervisor_id"] = value
+            final_entry['supervisor_id'] = value
           end
 
           def supervisor_id?
-            final_entry.key?("supervisor_id")
+            final_entry.key?('supervisor_id')
           end
 
           def filter_tags
-            final_entry["filter_tags"] || []
+            final_entry['filter_tags'] || []
           end
 
           def filter_tags?
-            final_entry.key?("filter_tags")
+            final_entry.key?('filter_tags')
+          end
+
+          def contractor_organization_id
+            final_entry['contractor_organization_id']
+          end
+
+          def contractor_organization_id?
+            final_entry.key?('contractor_organization_id')
           end
 
           def policy_group_ids
-            final_entry["policy_group_ids"] || []
+            final_entry['policy_group_ids'] || []
           end
 
           def policy_group_ids?
-            final_entry.key?("policy_group_ids")
+            final_entry.key?('policy_group_ids')
           end
 
           def default_tag?
-            final_entry.key?("default_tag")
+            final_entry.key?('default_tag')
           end
 
           def default_tag
-            final_entry["default_tag"]
+            final_entry['default_tag']
           end
 
           # Provides a reference to this person entry.
           # @return [String] string summary of this person identity.
           def identify
-            str_id = id ? "id: '#{id}'; " : ""
+            str_id = id ? "id: '#{id}'; " : ''
             "(row: #{idx}) '#{name}' (#{str_id}ext_id: '#{external_id}'; email: '#{email}')"
           end
 
@@ -200,7 +216,7 @@ module Eco
             else
               final_entry.each.map do |k, v|
                 "'#{k}': '#{v.to_json}'"
-              end.join(" | ")
+              end.join(' | ')
             end
           end
 
@@ -217,7 +233,7 @@ module Eco
             @final_entry.slice(*scoped_attrs).each do |attr, value|
               set_part(person, attr, value)
             rescue StandardError => e
-              raise unless attr == "email"
+              raise unless attr == 'email'
 
               log(:error) { "#{e} - setting blank email instead." }
               set_part(person, attr, nil)
@@ -284,7 +300,7 @@ module Eco
           def _external_serializing(mapped_entry)
             target_attrs    = @emap.all_model_attrs | @emap.aliased_attrs
             rest_keys       = mapped_entry.keys - target_attrs
-            target_attrs   -= ["send_invites"]
+            target_attrs   -= ['send_invites']
             external_entry  = target_attrs.each_with_object({}) do |attr, hash|
               unless hash.key?(ext_attr = @emap.to_external(attr))
                 hash[ext_attr] = mapped_entry[attr]
@@ -312,7 +328,7 @@ module Eco
           # @return [Hash] entry with **internal** names and **external** values and types.
           def _mapped_serializing(internal_entry)
             mapped_hash = internal_entry.merge(_serialize_values(internal_entry, :internal))
-            model_attrs = @person_parser.all_model_attrs - ["send_invites"]
+            model_attrs = @person_parser.all_model_attrs - ['send_invites']
             aux_hash    = mapped_hash.slice(*model_attrs)
             merge_missing_attrs(aux_hash, mapped_hash)
           end
@@ -383,7 +399,7 @@ module Eco
               hash.merge(hash_attr(attr, get_part(person.details, attr)))
             end
             merging(core_hash, account_hash, details_hash) do |final_entry|
-              final_entry["Has account?"] = !person.account.nil?
+              final_entry['Has account?'] = !person.account.nil?
               final_entry.merge(_serialize_values(person, :person))
             end
           end
@@ -412,14 +428,14 @@ module Eco
               end
               value = @person_parser.serialize(:multiple, value) if field.multiple
               if @person_parser.defined?(field.type.to_sym)
-                value = @person_parser.serialize(field.type.to_sym, value, deps: {"attr" => attr})
+                value = @person_parser.serialize(field.type.to_sym, value, deps: {'attr' => attr})
               end
               value
             elsif %w[policy_group_ids filter_tags login_provider_ids starred_ids].include?(attr)
               @person_parser.serialize(:multiple, value)
-            elsif %w[freemium accept_eula].include?(attr)
+            elsif %w[freemium accept_eula archived].include?(attr)
               @person_parser.serialize(:boolean, value)
-            elsif ["subordinates"].include?(attr)
+            elsif ['subordinates'].include?(attr)
               @person_parser.serialize(:number, value)
             else
               value
@@ -437,19 +453,19 @@ module Eco
               value = @person_parser.parse(:multiple, value) if field.multiple
 
               if @person_parser.defined?(field.type.to_sym)
-                value = @person_parser.parse(field.type.to_sym, value, deps: {"attr" => attr})
+                value = @person_parser.parse(field.type.to_sym, value, deps: {'attr' => attr})
               end
               value
-            elsif attr == "email"
+            elsif attr == 'email'
               value = value.strip.downcase if value
               value
             elsif %w[policy_group_ids filter_tags login_provider_ids starred_ids].include?(attr)
               value = @person_parser.parse(:multiple, value)
-              value = value.compact.map(&:upcase) if attr == "filter_tags"
+              value = value.compact.map(&:upcase) if attr == 'filter_tags'
               value
-            elsif %w[freemium accept_eula].include?(attr)
+            elsif %w[freemium accept_eula archived].include?(attr)
               @person_parser.parse(:boolean, value)
-            elsif ["subordinates"].include?(attr)
+            elsif ['subordinates'].include?(attr)
               @person_parser.parse(:number, value)
             else
               value
@@ -527,13 +543,13 @@ module Eco
             print_it = proc do |name, model|
               puts "#{name}:"
               pp model
-              puts "*" * 30
+              puts '*' * 30
             end
 
-            fin = proc { print_it.call("final_entry",    @final_entry)    }
-            int = proc { print_it.call("internal_entry", @internal_entry) }
-            mad = proc { print_it.call("mapped_entry",   @mapped_entry)   }
-            ext = proc { print_it.call("external_entry", @external_entry) }
+            fin = proc { print_it.call('final_entry',    @final_entry)    }
+            int = proc { print_it.call('internal_entry', @internal_entry) }
+            mad = proc { print_it.call('mapped_entry',   @mapped_entry)   }
+            ext = proc { print_it.call('external_entry', @external_entry) }
 
             call_order = parsing? ? [ext, mad, int, fin] : [fin, int, mad, ext]
             call_order.each(&:call)

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

@@ -12,14 +12,16 @@ module Eco
         #   name attributes, including _core_, _account_ and _details_.
         class PersonParser
           extend Eco::API::Common::ClassAutoLoader
-          autoloads_children_of     "Eco::API::Common::Loaders::Parser"
-          autoload_namespace_ignore "Eco::API"
+          autoloads_children_of     'Eco::API::Common::Loaders::Parser'
+          autoload_namespace_ignore 'Eco::API'
 
           CORE_ATTRS = %w[
             id external_id email name
             supervisor_id filter_tags
-            contractor_organization_id freemium
+            archived
+            contractor_organization_id
             brand_id
+            freemium
           ].freeze
           ACCOUNT_ATTRS = %w[
             policy_group_ids default_tag
@@ -39,7 +41,7 @@ module Eco
 
           # @example Example of usage:
           #  person_parser = PersonParser.new(schema: schema)
-          #  person_parser.define_attribute("example") do |parser|
+          #  person_parser.define_attribute('example') do |parser|
           #    parser.def_parser  do |str, deps|
           #      i = value.to_i rescue 0
           #      i +=5 if deps.dig(:sum_5)
@@ -82,7 +84,7 @@ module Eco
             return nil unless @schema
 
             @select_tables ||= @schema.fields.select do |fld|
-              fld.type == "select"
+              fld.type == 'select'
             end.to_h do |fld|
               msg = "The schema selection field '#{fld.name}' is missing selection options."
               raise msg unless fld.options&.any?
@@ -239,7 +241,7 @@ module Eco
           def define_attribute(attr, dependencies: {}, &definition)
             unless valid?(attr)
               msg =  "The attribute '#{attr_to_str(attr)}' is not part of "
-              msg << "core, account or target schema, or does "
+              msg << 'core, account or target schema, or does '
               msg << "not match any type: #{@details_attrs}"
               raise msg
             end

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

@@ -8,7 +8,9 @@ module Eco
         #   * `id`
         module SupervisorHelpers
           def self.included(base)
-            base.send(:include, ClassMethods)
+            super
+
+            base.send :include, ClassMethods
           end
 
           module ClassMethods

data/lib/eco/api/common/session/logger/channels.rb

@@ -9,13 +9,14 @@ module Eco
             class << self
               def included(base)
                 super
+
                 base.extend ClassMethods
               end
             end
 
             module ClassMethods
               def channels!(&def_block)
-                str = "Block with channel implementation expected. None given."
+                str = 'Block with channel implementation expected. None given.'
                 raise ArgumentError, str unless block_given?
 
                 channels.each do |channel|

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

@@ -73,5 +73,5 @@ module Eco
   end
 end
 
-require_relative "logger/cache"
-require_relative "logger/log"
+require_relative 'logger/cache'
+require_relative 'logger/log'

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

@@ -11,14 +11,14 @@ module Eco
                 source:      fetch_from,
                 message:     {
                   subject: {
-                    charset: "UTF-8",
+                    charset: 'UTF-8',
                     data:    subject
                   },
                   body:    {
                     # NOTE: (html) will let you send html instead
                     # you can use both at once if you like
                     text: {
-                      charset: "UTF-8",
+                      charset: 'UTF-8',
                       data:    body
                     }
                   }
@@ -59,6 +59,7 @@ module Eco
               }.tap do |dest|
                 cc  = [cc].flatten.compact.uniq
                 bcc = [bcc].flatten.compact.uniq
+
                 dest.merge!(cc_addresses: cc)   unless cc.empty?
                 dest.merge!(bcc_addresses: bcc) unless bcc.empty?
               end

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

@@ -9,6 +9,7 @@ module Eco
               def to_desc(to: nil, cc: nil, bcc: nil)
                 cc_to  = [cc].flatten.compact.uniq
                 bcc_to = [bcc].flatten.compact.uniq
+
                 { to_addresses: [to].flatten.compact.uniq }.tap do |dest|
                   dest.merge!(cc_addresses: cc_to)   unless cc_to.empty?
                   dest.merge!(bcc_addresses: bcc_to) unless bcc_to.empty?
@@ -26,7 +27,7 @@ module Eco
             end
 
             def send_mail(subject:, body:, to: nil, cc: nil, bcc: nil) # rubocop:disable Lint/UnusedMethodArgument
-              raise "You must implement this method"
+              raise 'You must implement this method'
             end
 
             def fetch_to(value = nil)

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

@@ -16,7 +16,7 @@ module Eco
                 bcc:     bcc
               )
 
-              mailer._("send").post(request_body: data)
+              mailer._('send').post(request_body: data)
             end
 
             def fetch_to(value = nil)
@@ -40,20 +40,20 @@ module Eco
 
             def to_data(subject:, body:, to: nil, cc: nil, bcc: nil)
               {
-                "personalizations" => [
+                'personalizations' => [
                   {
-                    "to"      => fetch_to(to).flatten,
-                    "subject" => subject
+                    'to'      => fetch_to(to).flatten,
+                    'subject' => subject
                   }.tap do |pers|
                     merge_if('cc', cc, target: pers)
                     merge_if('bcc', bcc, target: pers)
                   end
                 ],
-                "from"             => fetch_from,
-                "content"          => [
+                'from'             => fetch_from,
+                'content'          => [
                   {
-                    "type"  => "text/plain",
-                    "value" => body
+                    'type'  => 'text/plain',
+                    'value' => body
                   }
                 ]
               }
@@ -87,7 +87,7 @@ module Eco
                 return if value.to_s.strip.empty?
 
                 {
-                  "email" => value
+                  'email' => value
                 }
               end
             end

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

@@ -31,7 +31,7 @@ module Eco
             return false unless (serv = service)
 
             unless serv.configured?
-              msg  = "Mailer: You are missing configuration parameters "
+              msg  = 'Mailer: You are missing configuration parameters '
               msg << "for '#{provider}'. Review your .env file"
               log(:error) { msg }
               return false
@@ -48,10 +48,11 @@ module Eco
 
               to_addr = serv.fetch_to(to)
               msg     = "Sent email #{ProviderBase.to_desc(
-                to: to_addr,
-                cc: cc,
+                to:  to_addr,
+                cc:  cc,
                 bcc: bcc
               )}"
+
               puts msg
               log(:debug) { msg }
             end
@@ -69,6 +70,7 @@ module Eco
               msg = "Unknown mail provider '#{provider}'"
               puts msg
               log(:debug) { msg }
+
               nil
             end
           end

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

@@ -102,12 +102,12 @@ module Eco
           # @param local_folder [String] local destination folder (`"."` if not specified)
           # @return [Array<String>] list of created files
           def download(files, local_folder: nil, &block)
-            puts "Creating local files:"
+            puts 'Creating local files:'
             created_files = []
 
             [files].flatten.compact.map do |fullname|
               basename = windows_basename(fullname)
-              dest_fullname = File.join(local_folder || ".", basename)
+              dest_fullname = File.join(local_folder || '.', basename)
               puts " * #{dest_fullname}"
               created_files << dest_fullname
               sftp_session.download(fullname, dest_fullname)
@@ -118,6 +118,7 @@ module Eco
           end
 
           # Upload a file to the specific `remote_folder`
+          # @return [String, FalseClass] on success returns the remote file path.
           def upload(local_file, remote_folder:, gid: nil)
             return false unless local_file && File.exist?(local_file)
 
@@ -133,9 +134,15 @@ module Eco
             end
 
             log(:info) {
-              "Uploaded '#{local_file}' (#{res})"
+              "Uploaded '#{local_file}' as '#{dest_file}' (#{res})"
             }
-            true
+
+            dest_file
+          rescue StandardError
+            log(:error) {
+              "Could not upload file '#{dest_file}' (#{res})"
+            }
+            raise
           end
 
           private

data/lib/eco/api/common/version_patches/object.rb

@@ -2,8 +2,9 @@ Object.class_eval do
   unless method_defined?(:yield_self)
     define_method(:yield_self) do |&block|
       return block.call(self) if block
+
       out = self
-      out = [self] unless self.is_a?(Enumerable)
+      out = [self] unless is_a?(Enumerable)
       out.each
     end
   end

data/lib/eco/api/custom/mailer.rb

@@ -1,7 +1,7 @@
 # Helper class to create a custom `Config`
 # @example Example of usage:
 #  class Custom::Workflow::Mailer < Eco::API::Custom::Mailer
-#    ORG = "Org Name"
+#    ORG = 'Org Name'
 #  end
 class Eco::API::Custom::Mailer < Eco::API::Common::Loaders::Workflow::Mailer
   extend Eco::Language::Klass::WhenInherited

data/lib/eco/api/error/handlers.rb

@@ -2,8 +2,8 @@ module Eco
   module API
     class Error
       class Handlers < Eco::API::UseCases
-        autoloads_children_of "Eco::API::Common::Loaders::ErrorHandler"
-        autoload_namespace_ignore "Eco::API"
+        autoloads_children_of 'Eco::API::Common::Loaders::ErrorHandler'
+        autoload_namespace_ignore 'Eco::API'
 
         def define(*_args)
           raise "Missusage. You should use 'on' method instead"
@@ -12,7 +12,7 @@ module Eco
         # @param klass_err [Eco::API::Error] the specific error class that triggers this handler.
         def on(klass_err, type: :error_handler, retry: true, &block)
           Eco::API::Error.validate_err_class(klass_err)
-          raise "Expected block but not given" unless block
+          raise 'Expected block but not given' unless block
 
           Eco::API::Error::Handler.new(
             klass_err,