eco-helpers 3.0.4 → 3.0.6

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

@@ -4,7 +4,6 @@ module Eco
       module Session
         class Logger
           class Log
-
             attr_accessor :level, :datetime, :message, :formatted
 
             def initialize(level, datetime, message, formatted)
@@ -15,20 +14,22 @@ module Eco
             end
 
             def to_s
-              self.formatted
+              formatted
             end
 
             def <=>(other)
-              self.datetime <=> other.datetime
+              datetime <=> other.datetime
             end
 
             def before?(value)
-              return true if !value
+              return true unless value
+
               datetime <= to_datetime(value)
             end
 
             def after?(value)
-              return true if !value
+              return true unless value
+
               datetime >= to_datetime(value)
             end
 
@@ -36,10 +37,10 @@ module Eco
 
             def to_datetime(value)
               return value if value.is_a?(Time)
-              return nil unless value
+              return       unless value
+
               Time.parse(value)
             end
-
           end
         end
       end

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

@@ -1,12 +1,16 @@
+# rubocop:disable Naming/MethodParameterName
 module Eco
   module API
     module Common
       module Session
         class Mailer
+          include Eco::Language::AuxiliarLogger
 
           # @param enviro [Eco::API::Common::Session::Environment]
-          def initialize (enviro:)
-            raise "Required Environment object (enviro:). Given: #{enviro}" if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
+          def initialize(enviro:)
+            msg = "Required Environment object (enviro:). Given: #{enviro.class}"
+            raise msg if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
+
             @enviro = enviro
           end
 
@@ -14,28 +18,28 @@ module Eco
           # @param to [String] destination email address
           # @param subject [String] subject of the email
           # @param body [String] `html` or plain text message
-          def mail(to: nil, subject:, body:, cc: nil, bcc: nil)
+          def mail(subject:, body:, to: nil, cc: nil, bcc: nil)
             ses.send_email(
               destination: fetch_destination(to: to, cc: cc, bcc: bcc),
-              source:  fetch_from,
-              message: {
+              source:      fetch_from,
+              message:     {
                 subject: {
                   charset: "UTF-8",
-                  data: subject,
+                  data:    subject,
                 },
-                body: {
-                  # NOTE - html: will let you send html instead
+                body:    {
+                  # NOTE: (html) will let you send html instead
                   # you can use both at once if you like
                   text: {
                     charset: "UTF-8",
-                    data: body
+                    data:    body
                   }
                 }
               }
             ).tap do |response|
               msg = "Sent email (MessageId: #{response.message_id}) to #{fetch_destination(to: to, cc: cc, bcc: bcc)}"
               puts msg
-              logger.debug(msg)
+              log(:debug) { msg }
             end
           end
 
@@ -49,14 +53,17 @@ module Eco
                 secret_access_key: fetch_secret_access_key,
                 region:            fetch_region
               )
-            rescue Exception => e
-              logger.error("Trying to send an email with wrong email configuration: #{e}")
+            rescue StandardError => err
+              log(:error) {
+                "Trying to send an email with wrong email configuration: #{err}"
+              }
             end
+
             @ses
           end
 
           def logger
-            @enviro&.logger || ::Logger.new(IO::NULL)
+            @enviro&.logger || super
           end
 
           def config
@@ -104,3 +111,5 @@ module Eco
     end
   end
 end
+
+# rubocop:enable Naming/MethodParameterName

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

@@ -3,11 +3,15 @@ module Eco
     module Common
       module Session
         class S3Uploader
+          include Eco::Language::AuxiliarLogger
+
           attr_reader :prefix
 
           # @param enviro [Eco::API::Common::Session::Environment]
-          def initialize (enviro:)
-            raise "Required Environment object (enviro:). Given: #{enviro}" if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
+          def initialize(enviro:)
+            msg = "Required Environment object (enviro:). Given: #{enviro.class}"
+            raise msg if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
+
             @enviro    = enviro
             @prefix    = fetch_prefix
             @timestamp = Time.now.iso8601
@@ -18,22 +22,23 @@ module Eco
           # @param content [String] that to be uploaded
           # @return [String] S3 path to the uploaded `filename` object
           def upload(filename, content)
-            if obj = new_s3_object(filename)
+            if (obj = new_s3_object(filename))
               log_upload(obj) do
                 obj.put(body: content)
               end
             end
-            return full_path(obj)
+
+            full_path(obj)
           end
 
           # Uploads a single file
           # @param path [String] the target file to be uploaded
           # @return [String] S3 path to the uploaded `path` file
           def upload_file(path)
-            if File.exist?(path)
-              File.open(path, "rb") do |f|
-                upload(File.basename(path), f)
-              end
+            return unless File.exist?(path)
+
+            File.open(path, "rb") do |f|
+              upload(File.basename(path), f)
             end
           end
 
@@ -45,9 +50,10 @@ module Eco
             path      = File.expand_path(path)
             prefix    = File.expand_path(File.join(path, ".."))
             wildcard  = recurse ? "**/*" : "*"
+
             Dir.glob(File.join(path, wildcard)).sort.map do |file|
               next unless File.file?(file) # Skip directories
-              key = file.sub(prefix,"").gsub(/\\/,"/").sub(/^\/+/,"")
+              key = file.sub(prefix, "").gsub(/\\/, "/").sub(/^\/+/, "")
 
               File.open(file, "rb") do |f|
                 upload(key, f)
@@ -58,18 +64,18 @@ module Eco
           # @param path [String] a full path to a S3 object
           # @return [String] `link` to the S3 object on console
           def link(path)
-            unless path.is_a?(Enumerable)
-              return nil unless path.is_a?(String)
-              return "https://s3.console.aws.amazon.com/s3/object/#{path.sub("s3://","")}?region=#{fetch_region}&tab=overview"
-             return link
-           end
-           path.map {|pth| link(pth)}
+            return path.map { |pth| link(pth) } if path.is_a?(Enumerable)
+            return unless path.is_a?(String)
+
+            s3_path_str = "https://s3.console.aws.amazon.com/s3/object"
+            s3_params   = "region=#{fetch_region}&tab=overview"
+            "#{s3_path_str}/#{path.sub('s3://', '')}?#{s3_params}"
           end
 
           private
 
           def full_path(obj)
-            return "s3://#{bucket.name}/#{obj.key}" if obj
+            "s3://#{bucket.name}/#{obj.key}" if obj
           end
 
           def bucket
@@ -80,8 +86,10 @@ module Eco
                 secret_access_key: fetch_secret_access_key,
                 region:            fetch_region
               ).bucket(fetch_bucket)
-            rescue Exception => e
-              logger.error("Trying to upload to S3 with wrong configuration: #{e}")
+            rescue StandardError => err
+              log(:error) {
+                "Trying to upload to S3 with wrong configuration: #{err}"
+              }
             end
             @bucket
           end
@@ -97,11 +105,12 @@ module Eco
 
           def log_upload(obj)
             yield
-            logger.debug("Uploaded #{full_path(obj)}")
+
+            log(:debug) { "Uploaded #{full_path(obj)}" }
           end
 
           def logger
-            @enviro&.logger || ::Logger.new(IO::NULL)
+            @enviro&.logger || super
           end
 
           def config

data/lib/eco/api/microcases/people_search.rb

@@ -10,7 +10,7 @@ module Eco
       # @param options [Hash] the options.
       # @param silent [Boolean] `false` if low level search messages should be shown.
       # @return [Eco::API::Organization::People] the `People` object with the found persons.
-      def people_search(data, options: {}, silent: true) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def people_search(data, options: {}, silent: false) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         log(:info) { "Going to api get #{data.length} entries..." }
 
         silent &&= data.count <= 500

data/lib/eco/api/organization/login_providers.rb

@@ -8,7 +8,9 @@ module Eco
         def initialize(login_providers = [], klass: Ecoportal::API::Internal::LoginProvider, factory: nil)
           @klass       = Ecoportal::API::Internal::LoginProvider
           @caches_init = false
+
           super(login_providers, klass: @klass)
+
           init_caches
         end
 
@@ -88,7 +90,15 @@ module Eco
           @by_name = enabled_lps.each_with_object({}) do |lp, hash|
             hash[lp.name.downcase] = lp
 
-            hash['magic link'] = lp if lp.type == 'onetimepassword'
+            if lp.type == 'saml'
+              hash['sso'] = lp unless hash.key?('sso')
+            end
+
+            next unless lp.type == 'onetimepassword'
+
+            hash['magic link'] = lp
+            hash['magic_link'] = lp
+            hash['magiclink']  = lp
           end
 
           @by_type = enabled_lps.each_with_object({}) do |lp, hash|
@@ -99,15 +109,12 @@ module Eco
             if lp.type == 'saml'
               # only map the first :sso
               hash[:sso]  = lp unless hash.key?(:sso)
-              hash['sso'] = lp unless hash.key?('sso')
             end
 
             next unless lp.type == 'onetimepassword'
 
             hash[:magic_link]  = lp
             hash[:magiclink]   = lp
-            hash['magic_link'] = lp
-            hash['magiclink']  = lp
           end
 
           @caches_init = true

data/lib/eco/api/organization/node_classifications.rb

@@ -8,7 +8,9 @@ module Eco
         def initialize(types = [], klass: Ecoportal::API::GraphQL::Base::LocationClassificationType) # rubocop:disable Lint/UnusedMethodArgument
           @klass       = Ecoportal::API::GraphQL::Base::LocationClassificationType
           @caches_init = false
+
           super(types, klass: @klass)
+
           init_caches
         end
 
@@ -66,6 +68,7 @@ module Eco
 
         def treat_classication(value)
           return value unless value.is_a?(String)
+
           value.strip.gsub(/\W+/, '').downcase
         end
 

data/lib/eco/api/organization/presets_factory.rb

@@ -1,13 +1,11 @@
 module Eco
   module API
     module Organization
-
       class PresetsFactory
         ABILITIES = File.join(__dir__, 'presets_values.json')
         INTEGRITY = File.join(__dir__, 'presets_integrity.json')
 
         class << self
-
           def all_abilities(hash = {})
             Hash[abilities.each_with_object(nil).to_a].merge(hash)
           end
@@ -23,11 +21,12 @@ module Eco
           def abilities
             @abilities ||= abilities_model.keys
           end
-
         end
 
         def initialize(enviro: nil, policy_groups: nil)
-          fatal("Expecting Environment object. Given: #{enviro}") if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
+          msg = "Expecting Environment object. Given: #{enviro.class}"
+          fatal(msg) if enviro && !enviro.is_a?(Eco::API::Common::Session::Environment)
+
           @enviro        = enviro
           @policy_groups = policy_groups
         end
@@ -38,15 +37,16 @@ module Eco
         end
 
         def valid?(preset)
-          validate(perset).length == 0
+          validate(preset).empty?
         end
 
         def validate(preset)
           [].tap do |errors|
-            if err = preset_errors(preset)
+            if (err = preset_errors(preset))
               errors << "{ '#{key}' preset -> #{err}}"
             end
-            if err = preset_integrity(preset)
+
+            if (err = preset_integrity(preset))
               errors << "{ '#{key}' preset -> #{err}}"
             end
           end
@@ -55,54 +55,60 @@ module Eco
         private
 
         def compile(*presets)
-          presets.compact.reduce({}) do |p1, p2|
-            merge(p1, p2)
+          presets.compact.reduce({}) do |p_1, p_2|
+            merge(p_1, p_2)
           end
         end
 
-        def merge(preset1, preset2)
-          keys = preset1.keys | preset2.keys
+        def merge(preset_1, preset_2)
+          keys = preset_1.keys | preset_2.keys
 
           abilities_model.each_with_object({}) do |(key, values), result|
             next unless keys.include?(key)
+
             idx = [
-              values.index(preset1[key]),
-              values.index(preset2[key])
+              values.index(preset_1[key]),
+              values.index(preset_2[key])
             ].compact.max
+
             result[key] = idx && values[idx]
           end
         end
 
         def preset_errors(preset)
-          return "No preset given" if !preset
+          return "No preset given" unless preset
+
           errors = preset.map do |k, v|
             value_exists?(k, v) ? nil : "#{k}:#{v}"
           end.compact
-          return " Unknown: {#{errors.join(", ")}}" if errors.length > 0
-          nil
+
+          " Unknown: {#{errors.join(", ")}}" if errors.length.positive?
         end
 
-        def preset_integrity(preset)
+        def preset_integrity(preset) # rubocop:disable Metrics/AbcSize
           preset.each_with_object([]) do |(ability, value), errors|
-            next unless checks = integrity_model[ability]
+            next unless (checks = integrity_model[ability])
 
             suberrors = []
 
             checks.each do |check|
               next unless check["value"] == value
+
               check["conditions"].each do |cond, targets|
                 case cond
                 when "at_least"
                   targets.each do |other, minimum|
-                    unless (ability_value_idx(other, minimum) <= ability_value_idx(other, preset[other]))
-                      suberrors << "'#{other}' should be at least '#{minimum}'"
-                    end
+                    min_idx = ability_value_idx(other, minimum)
+                    oth_idx = ability_value_idx(other, preset[other])
+                    next if min_idx <= oth_idx
+
+                    suberrors << "'#{other}' should be at least '#{minimum}'"
                   end
                 when "one_of"
                   unless targets.any? {|other, expected| preset[other] == expected}
                     suberrors << targets.each_with_object([]) do |(other, expected), out|
                       out << "'#{other}': '#{expected}'"
-                    end.join(", ").yield_self do |msg|
+                    end.join(", ").then do |msg|
                       "there should be at least one of: {#{msg}}"
                     end
                   end
@@ -112,11 +118,11 @@ module Eco
               end
             end
 
-            if suberrors.length > 0
+            unless suberrors.empty?
               errors << "Incorrect value '#{value}' for '#{ability}' - reasons: {#{suberrors.join(", ")}}"
             end
-          end.yield_self do |errors|
-            " Integrity errors: { #{errors.join(", ")} }" if errors.length > 0
+          end.then do |errors|
+            " Integrity errors: { #{errors.join(", ")} }" unless errors.empty?
           end
         end
 
@@ -129,8 +135,8 @@ module Eco
         end
 
         def abilities_model_inverted
-          @abilities_model_inverted ||= abilities_model.each_with_object({}) do |(key, values), out|
-            out[key] = values.each_with_object({}) {|v, h| h[v] = true }
+          @abilities_model_inverted ||= abilities_model.transform_values do |values|
+            values.each_with_object({}) {|v, h| h[v] = true }
           end
         end
 
@@ -153,18 +159,18 @@ module Eco
         end
 
         def fatal(msg)
-          raise msg if !@enviro
+          raise msg unless @enviro
+
           @enviro.logger.fatal(msg)
           raise msg
         end
 
         def warn(msg)
-          raise msg if !@enviro
+          raise msg unless @enviro
+
           @enviro.logger.warn(msg)
         end
-
       end
-
     end
   end
 end

data/lib/eco/api/organization/tag_tree.rb

@@ -65,7 +65,7 @@ module Eco
             init_node
           end
 
-          self.path.push(self.id) unless top?
+          @path.push(self.id) unless top?
 
           @nodes = @raw_nodes.map.with_index do |cnode, idx|
             self.class.new(cnode, depth: depth + 1, path: @path.dup, parent: self, _weight: idx)
@@ -100,6 +100,7 @@ module Eco
         def merge(other)
           msg = "Expecting Eco::API::Organization::TagTree. Given: #{other.class}"
           raise ArgumentError, msg unless other.is_a?(Eco::API::Organization::TagTree)
+
           mid   = [id, other.id].join('|')
           mname = [name, other.name].join('|')
           self.class.new(as_json | other.as_json, id: mid, name: mname)
@@ -121,6 +122,7 @@ module Eco
         # @return [Enumerable<Eco::API::Organization::TagTree>]
         def each(&block)
           return to_enum(:each) unless block
+
           all_nodes.each(&block)
         end
 
@@ -130,9 +132,11 @@ module Eco
           raise ArgumentError, "Missing block" unless block_given?
           [].tap do |out_nodes|
             selected = false
+
             selected = (yield(self) == when_is) unless top?
             out_nodes.push(self)                if selected
             next                                unless selected || top?
+
             nodes.each do |nd|
               out_nodes.concat(nd.select(when_is: when_is, &block))
             end
@@ -154,6 +158,7 @@ module Eco
               out_nodes.push(self)
               yield(self) if block_given?
             end
+
             nodes.each do |nd|
               out_nodes.concat(nd.all_nodes(&block))
             end
@@ -165,10 +170,10 @@ module Eco
         # @return [Array<TagTree>] ancestors sorted from top to bottom.
         def ancestors
           [].tap do |ans|
-            unless parent.top?
-              ans << parent
-              ans.concat(parent.ancestors)
-            end
+            next if parent.top?
+
+            ans << parent
+            ans.concat(parent.ancestors)
           end
         end
 
@@ -321,6 +326,7 @@ module Eco
         # @return [TagTree, nil] if the tag `key` is a node, returns that node.
         def node(key)
           return nil unless tag?(key)
+
           @hash_tags[key.upcase]
         end
 
@@ -329,6 +335,7 @@ module Eco
         # @return [Array<String>]
         def filter_tags(list)
           return [] unless list.is_a?(Array)
+
           list.select {|str| tag?(str)}
         end
 
@@ -339,6 +346,7 @@ module Eco
         # @return [Array<String>]
         def path(key = nil)
           return @path.dup unless key
+
           @hash_paths[key.upcase].dup
         end
 
@@ -444,6 +452,7 @@ module Eco
           @hash_tags      = nodes.reduce(@hash_tags) do |h, n|
             h.merge(n.hash)
           end
+
           @hash_paths      = {}
           @hash_paths[@id] = @path unless top?
           @hash_paths      = nodes.reduce(@hash_paths) do |h, n|

data/lib/eco/api/policies/default_policies/99_user_access_policy.rb

@@ -5,11 +5,11 @@
 class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loaders::Policy
   name "default-user-access"
 
-  attr_reader   :session, :options, :job
+  attr_reader   :job
   attr_accessor :account_removed_count
 
-  def main(people, session, options, policy, job)
-    @session = session; @options = options; @job = job
+  def main(_peo, _sess, _opts, _plc, job)
+    @job = job
 
     self.account_removed_count = 0
 
@@ -17,9 +17,8 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
       remove_account_when_no_email!(person) if person.email.to_s.empty?
       next unless account = person.account
       next if options.dig(:exclude, :account)
-      if account.policy_group_ids.empty? && def_pg
-        account.policy_group_ids = [def_pg]
-      end
+
+      add_def_policy_group_if_applicable!(account)
       add_login_method_if_applicable!(account)
     end
 
@@ -29,30 +28,41 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
   private
 
   def warn_account_removal!
-    if account_removed_count > 0
-      msg = "(DefaultPolicy on job '#{job.name}') Removed account to #{account_removed_count} people"
-      session.logger.info(msg)
-    end
+    return unless account_removed_count.positive?
+
+    msg = "(DefaultPolicy on job '#{job.name}') Removed account to #{account_removed_count} people"
+    log(:info) { msg }
   end
 
   def remove_account_when_no_email!(person)
-    if person.account
-      self.account_removed_count += 1 if had_account?(person)
-      person.account = nil
-    end
+    return unless person.account
+
+    self.account_removed_count += 1 if had_account?(person)
+    person.account = nil
   end
 
   def had_account?(person)
     return false if person.new?
     return false if person.account_added?
-    return !!person.original_doc["account"]
+
+    !!person.original_doc["account"]
+  end
+
+  def add_def_policy_group_if_applicable!(account)
+    return unless account
+    return unless account.policy_group_ids.empty?
+    return unless def_pg
+
+    account.policy_group_ids = [def_pg]
   end
 
   def add_login_method_if_applicable!(account)
+    return unless account
     return unless account.as_update.key?("login_provider_ids")
-    if account.login_provider_ids.empty? && def_login
-      account.login_provider_ids = [def_login]
-    end
+    return unless account.login_provider_ids.empty?
+    return unless def_login
+
+    account.login_provider_ids = [def_login]
   end
 
   def def_pg