eco-helpers 3.0.25 → 3.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 209a98dac82894462d5ba24f82a85965cb10c14513d617e86d09fcfb96d3f81a
-  data.tar.gz: 288706b5a0f8a3aa81376edd2a42d61d690aae49cf6be6af9b7be5b52f34764a
+  metadata.gz: bc0d97c18d012621fea4cc9df6f7f3af54ba2a29da761c123c2502e7708f2267
+  data.tar.gz: ea83680a1a302da67ecdded6a0ea22043effe995d496c88289e7f55d54c9bde1
 SHA512:
-  metadata.gz: 3507855864665cf289361e803d5e9a835b9eb24d06e66a7249b4b8f9e0388eb65b51f5d8f634c0141a4562979dd69fb2df96c753de9325ef350351a6719be7f6
-  data.tar.gz: 8ef26aec84fd8ceb559fbf4a938f30f2b06f2abc73ce9fdf09b70e48fb3d4f7e0f0904ef65c5cd1dc81d1d143b1888d24c50e884884a34c321baf54022547dd4
+  metadata.gz: 2c0c45e02b3d5ee47fe5de33d38a4b1ade68eb759d1134b1df6c0880cbbba128f78299b2687af9177ca858a353e750339c2a85fc9731f78d194fd347faf329f0
+  data.tar.gz: 96e499c457c58667a29fffd0f0779bc986b6fc5635c1de4a5d0be5526778bd6065f6305f94c39f63badebfd8474ac76c5c780c766d28ae4824d1743ddf49e986

data/CHANGELOG.md

@@ -2,14 +2,52 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.0.26] - 2025-03-xx
+## [3.0.27] - 2025-03-xx
 
 ### Added
 
+- For `Ecoportal::API::V1::Person#archived` (**archived** flag)
+  - `PersonParser::CORE_ATTRS`: **exposed** `archived`
+  - Added `DefaultParsers::ArchivedParser`
+  - **Options** to **exclude** `archived`
+  - `PersonEntry`
+    - added methods `#archived` and `archived_key?`
+    - **enforced** `boolan` parsing and serializing
+- For `Ecoportal::API::V1::Person#contractor_organization_id`
+  - Added **option** to `exclude-contractor-organization` from people updates.
+  - `PersonEntry`
+    - added methods `#contractor_organization_id` and `contractor_organization_id?`
+- Updated `restore-db` case with the new exclusions
+  - Included copying of `contractor_organization_id` and `archived`
+- `Eco::Language::Delegation`
+  - See usage at <https://stackoverflow.com/a/79537526/4352306> for usage.
+
 ### Changed
 
+- Moved `Lib::Sftp` and `Lib::FilePattern` to `Lib::Files`
+- `Lib::Files::Sftp`: some configurable parameters could already exist via **method**
+  - Check if `super` exists
+  - This gives precedence to existing methods (over i.e. **const**, over **options** cli modifiers; ... may need review at a later stage)
+- `Eco::API::Common::People::DefaultParsers::BooleanParser`
+  - Renamed method from `truthy` to `truthy?`
+- upgraded `ecoportal-api` gem
+
 ### Fixed
 
+- align `respond_to` with `send` (should check private methods too).
+- `Lib::Files::FilePattern`
+  - should allow `file_pattern` method to be **private**.
+- `ClassHelpers`... `inherited` should call **super**.
+
+## [3.0.26] - 2025-03-23
+
+### Added
+
+- default constant for `FILE_PATTERN`
+- `Loaders::Base` **added**:
+  - `#api_space` and `#api_space_default?`
+- `GROUP_ID` constant to also spot the sftp **gid**
+
 ## [3.0.25] - 2025-03-23
 
 ### Added

data/eco-helpers.gemspec

@@ -40,7 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'bcrypt_pbkdf',  '~> 1.0'
   spec.add_dependency 'docx',          '>= 0.8.0', '< 0.9'
   spec.add_dependency 'dotenv',        '~> 3'
-  spec.add_dependency 'ecoportal-api',         '~> 0.10', '>= 0.10.8'
+  spec.add_dependency 'ecoportal-api',         '~> 0.10', '>= 0.10.9'
   spec.add_dependency 'ecoportal-api-graphql', '~> 0.4',  '>= 0.4.5'
   spec.add_dependency 'ecoportal-api-v2',      '~> 2.0',  '>= 2.0.16'
   spec.add_dependency 'ed25519',       '~> 1.2'

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

@@ -27,11 +27,23 @@ module Eco
           # @note
           #   - this method should implement the loading logics for the given `Children` class.
           def initialize
-            raise "You should implement this method"
+            raise 'You should implement this method'
           end
 
           private
 
+          def api_space_default?
+            space = api_space
+            return true if space.nil?
+            return true if space == :default
+
+            false
+          end
+
+          def api_space
+            options.dig(:api, :space)
+          end
+
           def simulate?
             options[:simulate] || options[:dry_run]
           end

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

@@ -23,7 +23,7 @@ module Eco
               return unless @name
 
               msg  = "You have already declared #{self} "
-              msg << "or you are trying to give it a name twice"
+              msg << 'or you are trying to give it a name twice'
               raise msg if @name
             end
           end

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

@@ -32,7 +32,7 @@ module Eco
           # @param handler [Eco::API::Error::Hanlder] the `error handler` instance object.
           # @param job [Eco::API::Session::Batch::Job] the `Batch::Job` made on purpose for this handler.
           def main(data, session, options, handler, job) # rubocop:disable Lint/UnusedMethodArgument
-            raise "You should implement this method"
+            raise 'You should implement this method'
           end
 
           def error

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

@@ -134,7 +134,7 @@ module Eco
           #     (i.e. Array instread of String with '|' delimiters).
           # @param deps [Hash] the merged dependencies (default to the class object and when calling the parser).
           def parser(_data, _deps)
-            raise "You should implement this method"
+            raise 'You should implement this method'
           end
 
           # @param data [Hash, Ecoportal::API::V1::Person] all the person data at the specified `serializing_phase`:
@@ -144,7 +144,7 @@ module Eco
           #   - when `:person`: it will receive the `person` object.
           # @param deps [Hash] the merged dependencies (default to the class object and when calling the parser).
           # def serializer(data, deps)
-          #   raise "You should implement this method"
+          #   raise 'You should implement this method'
           # end
 
           # @return [String, Symbol] the field/attribute or type this parser is linked to.

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

@@ -17,7 +17,7 @@ module Eco
           # @param policy [Eco::API::Policies::Policy] the `policy` instance object.
           # @param job [Eco::API::Session::Batch::Job] the `Batch::Job` that these `people` belong to the queue thereof.
           def main(data, session, options, policy, job = nil) # rubocop:disable Lint/UnusedMethodArgument
-            raise "You should implement this method"
+            raise 'You should implement this method'
           end
         end
       end

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

@@ -33,7 +33,7 @@ module Eco
           # @param options [Hash] the options that modify the case behaviour or bring some dependencies.
           # @param usecase [Eco::API::Policies::Policy] the `usecase` instance object.
           def main(*_args)
-            raise "You should implement this method"
+            raise 'You should implement this method'
           end
 
           def cli_apply!

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

@@ -0,0 +1,19 @@
+class Eco::API::Common::People::DefaultParsers::ArchivedParser < Eco::API::Common::Loaders::Parser
+  attribute 'archived'
+
+  def parser(hash, _deps)
+    value = hash[attribute]
+    value = value.first if value.is_a?(Array)
+    truthy?(value)
+  end
+
+  def serializer(person, _deps)
+    person.archived?.to_s
+  end
+
+  private
+
+  def truthy?(value)
+    %w[true y yes x].include?(value.to_s&.downcase)
+  end
+end

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

@@ -1,17 +1,17 @@
 class Eco::API::Common::People::DefaultParsers::BooleanParser < Eco::API::Common::Loaders::Parser
   attribute :boolean
 
-  def parser(value, deps)
-    value.is_a?(Array) ? value.map { |v| truthy(v) } : truthy(value)
+  def parser(value, _deps)
+    value.is_a?(Array) ? value.map { |v| truthy?(v) } : truthy?(value)
   end
 
-  def serializer(value, deps)
+  def serializer(value, _deps)
     value.to_s
   end
 
   private
 
-  def truthy(value)
+  def truthy?(value)
     %w[true y yes x].include?(value.to_s.strip.downcase)
   end
 end

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

@@ -16,7 +16,7 @@ class Eco::API::Common::People::DefaultParsers::DateParser < Eco::API::Common::L
 
   def parse_date(value, attr:)
     return value.map {|val| parse_date(val, attr: attr)}.compact if value.is_a?(Enumerable)
-    return nil if blank?(value)
+    return if blank?(value)
 
     value = value.to_s.strip
     return wrong!(value, attr: attr) unless date?(value)
@@ -31,9 +31,9 @@ class Eco::API::Common::People::DefaultParsers::DateParser < Eco::API::Common::L
 
   def serialize_date(value)
     return value.map {|val| serialize_date(val)}.compact if value.is_a?(Enumerable)
-    return nil   if blank?(value)
+    return       if blank?(value)
     return value if value.is_a?(String)
-    return nil   unless [Date, Time].any? {|type| value.is_a?(type)}
+    return       unless [Date, Time].any? {|type| value.is_a?(type)}
 
     value&.strftime('%Y-%m-%d')
   rescue TypeError, Date::Error

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

@@ -1,19 +1,19 @@
 class Eco::API::Common::People::DefaultParsers::FreemiumParser < Eco::API::Common::Loaders::Parser
-  attribute "freemium"
+  attribute 'freemium'
 
-  def parser(hash, deps)
-    value = hash["freemium"]
+  def parser(hash, _deps)
+    value = hash['freemium']
     value = value.first if value.is_a?(Array)
-    truthy(value)
+    truthy?(value)
   end
 
-  def serializer(person, deps)
+  def serializer(person, _deps)
     person.freemium&.to_s
   end
 
   private
 
-  def truthy (value)
+  def truthy?(value)
     %w[true y yes x].include?(value.to_s&.downcase)
   end
 end

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

@@ -1,10 +1,10 @@
 class Eco::API::Common::People::DefaultParsers::LoginProvidersParser < Eco::API::Common::Loaders::Parser
-  attribute "login_provider_ids"
+  attribute 'login_provider_ids'
   parsing_phase     :final
   serializing_phase :final
 
   def parser(hash, _deps)
-    hash["login_provider_ids"].map do |name|
+    hash['login_provider_ids'].map do |name|
       login_providers.to_id(name&.downcase&.strip).tap do |known|
         unless !name || known || unknown_pgs.include?(name)
           unknown_pgs.push(name)
@@ -15,7 +15,7 @@ class Eco::API::Common::People::DefaultParsers::LoginProvidersParser < Eco::API:
   end
 
   def serializer(hash, _deps)
-    if (ids = hash["login_provider_ids"])
+    if (ids = hash['login_provider_ids'])
       login_providers.to_name(ids)
     else
       []

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

@@ -1,12 +1,12 @@
 class Eco::API::Common::People::DefaultParsers::MultiParser < Eco::API::Common::Loaders::Parser
   attribute :multiple
 
-  def parser(value, deps)
+  def parser(value, _deps)
     into_a(value)
   end
 
-  def serializer(value, deps)
-    into_a(value).join("|")
+  def serializer(value, _deps)
+    into_a(value).join('|')
   end
 
   private
@@ -14,7 +14,7 @@ class Eco::API::Common::People::DefaultParsers::MultiParser < Eco::API::Common::
   def into_a(value)
     return []               if value.nil?
     return value            if value.is_a?(Array)
-    return value.split("|") if value.is_a?(String) && value.include?("|")
+    return value.split('|') if value.is_a?(String) && value.include?('|')
     [].push(value)
   end
 end

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

@@ -1,15 +1,18 @@
 class Eco::API::Common::People::DefaultParsers::PolicyGroupsParser < Eco::API::Common::Loaders::Parser
-  attribute "policy_group_ids"
+  attribute 'policy_group_ids'
   parsing_phase :final
 
   def parser(hash, _deps)
-    policy_group_ids = hash["policy_group_ids"] || []
+    policy_group_ids = hash['policy_group_ids'] || []
+
     policy_group_ids.map do |name|
       policy_groups.to_id(name&.downcase&.strip).tap do |known|
-        unless !name || known || unknown_pgs.include?(name)
-          unknown_pgs.push(name)
-          log(:warn) { "Unknown Policy Group: '#{name}'" }
-        end
+        next if known
+        next if name.nil?
+        next if unknown_pgs.include?(name)
+
+        unknown_pgs.push(name)
+        log(:warn) { "Unknown Policy Group: '#{name}'" }
       end
     end.compact.tap do |pg_names|
       pg_names.push(default_id) if pg_names.empty?

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

@@ -1,20 +1,21 @@
 class Eco::API::Common::People::DefaultParsers::SendInvitesParser < Eco::API::Common::Loaders::Parser
-  attribute "send_invites"
+  attribute 'send_invites'
 
   def parser(hash, _deps)
-    value = hash["send_invites"]
+    value = hash['send_invites']
     value = value.first if value.is_a?(Array)
-    truthy(value)
+    truthy?(value)
   end
 
   def serializer(person, _deps)
-    return unless account = person.account
+    return unless (account = person.account)
+
     account.send_invites&.to_s
   end
 
   private
 
-  def truthy(value)
+  def truthy?(value)
     %w[true y yes x].include?(value.to_s&.downcase)
   end
 end

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

@@ -12,7 +12,7 @@ class Eco::API::Common::People::DefaultParsers::XLSParser < Eco::API::Common::Lo
   end
 
   def serializer(_array_hash, _deps)
-    raise "Not implemented. TODO: using axlsx or rubyXL gems. See: https://spin.atomicobject.com/2017/03/22/parsing-excel-files-ruby/"
+    raise 'Not implemented. TODO: using axlsx or rubyXL gems. See: https://spin.atomicobject.com/2017/03/22/parsing-excel-files-ruby/'
   end
 
   private
@@ -28,7 +28,7 @@ class Eco::API::Common::People::DefaultParsers::XLSParser < Eco::API::Common::Lo
 
   def expected_headers
     log(:info) {
-      "Headers detection is using your fields_map.json file (native behaviour)"
+      'Headers detection is using your fields_map.json file (native behaviour)'
     }
     session.fields_mapper.list(:external).uniq
   end

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

@@ -19,6 +19,7 @@ require_relative 'default_parsers/numeric_parser'
 require_relative 'default_parsers/date_parser'
 require_relative 'default_parsers/multi_parser'
 require_relative 'default_parsers/send_invites_parser'
+require_relative 'default_parsers/archived_parser'
 require_relative 'default_parsers/freemium_parser'
 require_relative 'default_parsers/policy_groups_parser'
 require_relative 'default_parsers/login_providers_parser'

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