eco-helpers 3.0.4 → 3.0.6

data/lib/eco/api/session/batch/status.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Naming/MethodParameterName
 module Eco
   module API
     class Session
@@ -6,18 +7,15 @@ module Eco
         #   1. what has happened during the execution of a `Session::Batch` (i.e. errors)
         #   2. be able to build a summary of what happened
         #   3. gather the people that was returned as a result of the `batch` (for `get` batch type)
-        # @attr_reader source_queue [Array<Hash>, Array<Ecoportal::API::V1::Person>, Array<Ecoportal::API::Internal::Person>]
+        # @attr_reader source_queue [Array<Hash>, Array<Ecoportal::API::V1::Person>,
+        #   Array<Ecoportal::API::Internal::Person>]
         #   The queue as it was originally made (it could contain duplicates)
         # @attr_reader queue [Array<Hash>, Array<Ecoportal::API::V1::Person>, Array<Ecoportal::API::Internal::Person>]
         #   `source_queue` with no repeated elements (**note**: observe that the elimination of duplicates could fail)
         # @attr_reader mode [Symbol] the `mode` that the `batch` was run with
         # @attr_reader root [Eco::API::Session::Job] the `job` that launched the `batch`
         class Status < Eco::API::Common::Session::BaseSession
-          @modes = [:exact, :search]
-
-          attr_reader :source_queue
-          attr_reader :queue, :method, :mode
-          attr_reader :root
+          @modes = %i[exact search]
 
           class << self
             attr_reader :modes
@@ -27,13 +25,25 @@ module Eco
             end
           end
 
-          # @param e [Eco::API::Common::Session::Environment] requires a session environment, as any child of `Eco::API::Common::Session::BaseSession`
-          # @param queue  [Array<Hash>, Array<Ecoportal::API::V1::Person>, Array<Ecoportal::API::Internal::Person>] the `source_queue`
+          attr_reader :source_queue
+          attr_reader :queue, :method, :mode
+
+          # Nativelly to this gem, a batch against the server is lauched by an Eco::API::Session::Job.
+          # When the batch returns the `BatchStatus`, the `Job` assigns itself as `root` of it.
+          # @param object [Eco::API::Session::Job]
+          attr_accessor :root
+
+          # @param e [Eco::API::Common::Session::Environment] requires a session environment,
+          #   as any child of `Eco::API::Common::Session::BaseSession`
+          # @param queue  [Array<Hash>, Array<Ecoportal::API::V1::Person>, Array<Ecoportal::API::Internal::Person>]
+          #   the `source_queue`
           # @param method [Symbol] the type of `batch operation`
           # @param mode [Symbol] the mode of `batch operation`. It can be `:search` or `:exact`
-          def initialize(e, queue:, method:, mode: :exact)
-            super(e)
-            fatal("In batch operations you must batch an Enumerable. Received: #{queue}")  unless queue && queue.is_a?(Enumerable)
+          def initialize(ev, queue:, method:, mode: :exact)
+            super(ev)
+
+            msg = "In batch operations you must batch an Enumerable. Received: #{queue.class}"
+            fatal(msg) unless queue.is_a?(Enumerable)
 
             self.mode     = mode
             @method       = method
@@ -41,8 +51,12 @@ module Eco
 
             que = queue.to_a
             que = queue if queue.respond_to?(:uniq)
+
             if que.length != que.uniq.length
-              logger.warn("Please, review your entries-to-query builder, you have repeated entries")
+              log(:warn) {
+                "Please, review your entries-to-query builder, you have repeated entries"
+              }
+
               queue = que.uniq
             end
 
@@ -50,20 +64,16 @@ module Eco
             @hash   = @queue.each_with_index.map do |entry, i|
               [entry, i]
             end.to_h
+
             @responses    = []
             @person_match = []
             @people_match = Array.new(@queue.length, [])
           end
 
-          # Nativelly to this gem, a batch against the server is lauched by an Eco::API::Session::Job.
-          # When the batch returns the `BatchStatus`, the `Job` assigns itself as `root` of it.
-          # @param object [Eco::API::Session::Job]
-          def root=(object)
-            @root = object
-          end
-
           def mode=(value)
-            fatal("Invalid :mode '#{value}. You must specify mode: as one of #{self.class.modes} ") unless self.class.valid_mode?(value)
+            msg = "Invalid :mode '#{value}'. You must specify mode: as one of #{self.class.modes} "
+            fatal(msg) unless self.class.valid_mode?(value)
+
             @mode = value
           end
 
@@ -79,10 +89,12 @@ module Eco
           end
 
           # Get the assciated `reponse` of an input entry object `key`
-          # @param key [Integer, Hash, Ecoportal::API::V1::Person, Ecoportal::API::Internal::Person] these are the **index options**:
+          # @param key [Integer, Hash, Ecoportal::API::V1::Person, Ecoportal::API::Internal::Person]
+          #   these are the **index options**:
           #   1. `Integer`: index/position of the entry in the final `queue`
           #   2. `Hash`: entry queries can be raw `Hash` objects
-          #   3. `Person` object: the most common case is to use the person wrapper classes of the `Ecoportal::API` namespace.
+          #   3. `Person` object: the most common case is to use the person
+          #     wrapper classes of the `Ecoportal::API` namespace.
           # @return [Ecoportal::API::Common::BatchResponse]
           def [](key)
             @responses[to_index(key)]
@@ -121,12 +133,13 @@ module Eco
           # @return [Integer] the actual `index`
           def valid_index(index: nil, entry: nil)
             index ||= @hash[entry]
-            unless index && index < @queue.length
-              msg  = "You must provide either the index on the final 'queue' or the original entry object of the batch. "
-              msg += "Given, index=#{index.class}, entry:#{entry.class}"
-              fatal msg
-            end
-            index
+
+            return index if index && index < @queue.length
+
+            msg  = "You must provide either the index on the final 'queue' "
+            msg << "or the original entry object of the batch. "
+            msg << "Given, index=#{index.class}, entry:#{entry.class}"
+            fatal msg
           end
 
           # @!group Get-specific helpers
@@ -137,14 +150,14 @@ module Eco
           # @see Eco::API::Session::Batch::Status#[] for `key` options
           # @return [Ecoportal::API::V1::Person, Ecoportal::API::Internal::Person]
           def person(key)
-            return self[key].result if success?(key)
-            nil
+            self[key].result if success?(key)
           end
 
           # The _person_ we got from the Server wrapped to the `Person` object for the input entry object `key`
           # @note
           #   - it only makes sense when the _batch method_ used was `get` with `q`
-          #   - **found using a search criteria** (`mode` == `:search`), as opposite to find the person directly by `external_id`
+          #   - **found using a search criteria** (`mode` == `:search`), as opposite
+          #     to find the person directly by `external_id`
           # @param key [Integer, Hash, Ecoportal::API::V1::Person, Ecoportal::API::Internal::Person]
           # @see Eco::API::Session::Batch::Status#[] for `key` options
           # @return [Ecoportal::API::V1::Person, Ecoportal::API::Internal::Person]
@@ -169,9 +182,12 @@ module Eco
           #   - while `:exact` mode will keep the order of found people as per order of final `queue`
           #   - `:search` mode will just gather the results (order won't match)
           # @raise [Exception] when the `method` of the batch operation was other than `get`
-          # @return [Array<Ecoportal::API::V1::Person>, Array<Ecoportal::API::Internal::Person>] all the people that has been found.
+          # @return [Array<Ecoportal::API::V1::Person>, Array<Ecoportal::API::Internal::Person>]
+          #   all the people that has been found.
           def people
-            fatal "This batch wasn't a 'get'. Can't obtain people without 'get' method" unless method == :get
+            msg = "This batch wasn't a 'get'. Can't obtain people without 'get' method"
+            fatal msg unless method == :get
+
             if mode == :exact
               out = Array(queue.length)
               @responses.each_with_index do |response, i|
@@ -179,19 +195,22 @@ module Eco
               end
             elsif mode == :search
               out = []
-              queue.each_with_index.map do |entry, i|
+
+              queue.each_with_index.map do |entry, _i|
                 pers   = person(entry)
                 pers ||= person_match(entry)
                 ppl    = pers ? [pers] : people_match(entry)
-                out += ppl
+
+                out   += ppl
               end
             end
             out
           end
           # @!endgroup
-
         end
       end
     end
   end
 end
+
+# rubocop:enable Naming/MethodParameterName

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

@@ -141,7 +141,7 @@ module Eco
               msg  = "starting batch '#{method}' iteration #{iteration}/#{iterations},"
               msg << " with #{slice.length} entries of #{data.length} -- #{done} done"
               msg << " (last: #{str_stats(start_slice, slice.length)}; total: #{str_stats(start_time, done)})"
-              logger.info(msg) unless silent
+              log(:info) { msg } unless silent
 
               start_slice = Time.now
               offer_retry_on(Ecoportal::API::Errors::TimeOut) do
@@ -166,7 +166,7 @@ module Eco
             # temporary working around (due to back-end problems with batch/jobs)
             unless pending_for_server_error.empty?
               msg = "Going to re-try #{pending_for_server_error.count} due to server errors"
-              logger.info(msg) unless silent
+              log(:info) { msg } unless silent
 
               launch_batch(
                 pending_for_server_error,

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

@@ -3,13 +3,12 @@ module Eco
     class Session
       class Config
         class BaseConfig < Hash
-          attr_reader :config
-
           class << self
             def attr_key(*attrs)
               attrs.each do |attr|
-                method = "#{attr}".freeze
-                if self.instance_methods.include?(method.to_sym)
+                method = attr.to_s.freeze
+
+                if instance_methods.include?(method.to_sym)
                   puts "WARNING (#{self}): redefining method already defined '#{method}'."
                 end
 
@@ -25,6 +24,10 @@ module Eco
             end
           end
 
+          include Eco::Language::AuxiliarLogger
+
+          attr_reader :config
+
           def initialize(config:)
             super(nil)
             @config = config
@@ -40,14 +43,12 @@ module Eco
 
           def clone(config:)
             keys.each_with_object(self.class.new(config: config)) do |key, cnf|
+              cnf[key] = self[key].clone(config: cnf)
+            rescue ArgumentError
               begin
-                cnf[key] = self[key].clone(config: cnf)
-              rescue ArgumentError
-                begin
-                  cnf[key] = self[key].clone
-                rescue TypeError
-                  cnf[key] = self[key]
-                end
+                cnf[key] = self[key].clone
+              rescue TypeError
+                cnf[key] = self[key]
               end
             end
           end

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

@@ -83,14 +83,14 @@ module Eco
               if tree
                 msg = "LIVE LOCATIONS Structure (#{tree.id}): '#{tree.name}' (#{tree.count} nodes)"
                 if first_load
-                  session_logger.info("Using #{msg}")
+                  log(:info) { "Using #{msg}" }
                 elsif switching_target
-                  session_logger.info("Switched to #{msg}")
+                  log(:info) { "Switched to #{msg}" }
                 else # refresh_cache
-                  session_logger.debug("Reloading #{msg}")
+                  log(:debug) { "Reloading #{msg}" }
                 end
               else
-                session_logger.info "Could not retrive live tree (#{id})"
+                log(:info) { "Could not retrive live tree (#{id})" }
               end
             end
           end
@@ -117,7 +117,9 @@ module Eco
             Eco::API::Organization::TagTree.new(tree.treeify, id: tree.id, name: tree.name).tap do |eco_tree|
               cnt     = eco_tree.count
               per_sec = (cnt.to_f / secs).round(2)
-              session_logger.info("Loaded #{cnt} location nodes in #{secs} seconds (#{per_sec} nodes/sec)")
+              log(:info) {
+                "Loaded #{cnt} location nodes in #{secs} seconds (#{per_sec} nodes/sec)"
+              }
             end
           end
 
@@ -145,7 +147,9 @@ module Eco
                 eco_trees.push(eco_tree)
               end
               per_sec = (cnt.to_f / secs).round(2)
-              session_logger.info("Loaded #{cnt} location nodes in #{secs} seconds (#{per_sec} nodes/sec)")
+              log(:info) {
+                "Loaded #{cnt} location nodes in #{secs} seconds (#{per_sec} nodes/sec)"
+              }
             end
           end
 
@@ -156,14 +160,6 @@ module Eco
 
             apis.api(version: :graphql)
           end
-
-          def session
-            ASSETS.session
-          end
-
-          def session_logger
-            session.logger
-          end
         end
       end
     end

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

@@ -56,6 +56,7 @@ module Eco
 
           def name(with_path: false)
             return @name if !with_path || root?
+
             [@_parent.name(with_path: true), @name].compact.join('.')
           end
 
@@ -80,6 +81,7 @@ module Eco
           def skip?
             return @skip if instance_variable_defined?(:@skip)
             return false if root?
+
             @_parent.skip?
           end
 
@@ -97,9 +99,11 @@ module Eco
           #   2. if block is not provided, it returns the **stage** referred by `key`
           def for(key = nil, &block)
             raise ArgumentError, "With no 'key', a block should be given." unless key || block_given?
+
             tap do
               next yield(self)            unless key
               next stage(key).for(&block) if block_given?
+
               return stage(key)
             end
           end
@@ -118,11 +122,13 @@ module Eco
           # @return [Eco::API::Session::Config::Workflow] the current stage object (to ease chainig).
           def on(key = nil, &block)
             raise ArgumentError, "A block should be given." unless block_given?
+
             if key
               stage(key).on(&block)
             else
               @on = block
             end
+
             self
           end
 
@@ -247,6 +253,7 @@ module Eco
 
           def path
             return name if root?
+
             "#{@_parent.path}:#{name}"
           end
 
@@ -273,7 +280,10 @@ module Eco
           end
 
           def run_it(io, &block)
-            io.session.logger.debug("(Workflow: #{path}) running now")
+            io.session.log(:debug) {
+              "(Workflow: #{path}) running now"
+            }
+
             if block
               io = io_result(io: io) do
                 io.evaluate(self, io, &block)
@@ -286,9 +296,11 @@ module Eco
               end
 
               unless ready?
-                msg = "(Workflow: #{path}) 'on' callback is not defined, nor block given"
-                io.session.logger.debug(msg)
+                io.session.log(:debug) {
+                  "(Workflow: #{path}) 'on' callback is not defined, nor block given"
+                }
               end
+
               io = io_result(io: io) do
                 io.evaluate(self, io, &@on)
               end

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

@@ -14,11 +14,9 @@ module Eco
 
         def clone(name)
           keys.each_with_object(self.class.new(name)) do |key, cnf|
-            begin
-              cnf[key] = self[key].clone(config: cnf)
-            rescue ArgumentError
-              cnf[key] = self[key].clone
-            end
+            cnf[key] = self[key].clone(config: cnf)
+          rescue ArgumentError
+            cnf[key] = self[key].clone
           end
         end
 
@@ -32,7 +30,7 @@ module Eco
         # Helper to manage `SFTP` files and folders.
         # @return [Eco::API::Session::Config::SFTP]
         def sftp
-          self["sftp"]       ||= Eco::API::Session::Config::SFTP.new(config: self)
+          self["sftp"] ||= Eco::API::Session::Config::SFTP.new(config: self)
         end
 
         # Helper to upload files and folders to `S3`.
@@ -44,7 +42,7 @@ module Eco
         # Helper to send emails.
         # @return [Eco::API::Session::Config::Mailer]
         def mailer
-          self["mailer"]     ||= Eco::API::Session::Config::Mailer.new(config: self)
+          self["mailer"] ||= Eco::API::Session::Config::Mailer.new(config: self)
         end
 
         # Helper scope reporting structures.
@@ -58,7 +56,7 @@ module Eco
 
         # @return [Eco::API::Session::Config::Logger]
         def logger
-          self["logger"]     ||= Eco::API::Session::Config::Logger.new(config: self)
+          self["logger"] ||= Eco::API::Session::Config::Logger.new(config: self)
         end
 
         def log_console_level=(value)
@@ -86,7 +84,7 @@ module Eco
 
         # @return [Eco::API::Session] the `session` linked to this `config`
         def session
-          @session     ||= Eco::API::Session.new(self)
+          @session ||= Eco::API::Session.new(self)
         end
 
         # @return [Eco::API::Session::Config::Apis]
@@ -157,7 +155,7 @@ module Eco
 
         # @return [Eco::API::Session::Config::Files]
         def files
-          self["files"]      ||= Eco::API::Session::Config::Files.new(config: self)
+          self["files"] ||= Eco::API::Session::Config::Files.new(config: self)
         end
 
         # Defines in the base folder from where files are expected to be found when relative paths are used
@@ -192,22 +190,18 @@ module Eco
         end
 
         def require(file = nil, match: nil)
-          begin
-            if match
-              file_manager.dir.dir_files(pattern: match).each do |file|
-                require_relative File.expand_path(file)
-              end
-            else
-              target = File.expand_path(file_manager.dir.file(file))
-              require_relative target
-            end
-          rescue LoadError => e
-            if apis.active_api.one_off?
-              pp e.to_s
-            else
-              raise
+          if match
+            file_manager.dir.dir_files(pattern: match).each do |file|
+              require_relative File.expand_path(file)
             end
+          else
+            target = File.expand_path(file_manager.dir.file(file))
+            require_relative target
           end
+        rescue LoadError => err
+          raise unless apis.active_api.one_off?
+
+          pp err.to_s
         end
         # @!endgroup
 
@@ -403,7 +397,7 @@ module Eco
 
         # @return [Eco::API::Session::Config::Workflow]
         def workflow
-          @workflow = self["workflow"]  ||= Eco::API::Session::Config::Workflow.new(config: self)
+          @workflow = self["workflow"] ||= Eco::API::Session::Config::Workflow.new(config: self)
           @workflow.tap do |wf|
             yield(wf) if block_given?
           end
@@ -421,7 +415,6 @@ module Eco
           self["delay_between_job_groups"]
         end
         # @!endgroup
-
       end
     end
   end

data/lib/eco/api/session.rb

@@ -22,7 +22,9 @@ module Eco
         @entry_factories  = {}
         @person_factories = {}
 
-        logger.debug("LINE COMMAND: #{$0} #{ARGV.join(" ")}") # rubocop:disable Style/SpecialGlobalVars
+        log(:debug) {
+          "LINE COMMAND: #{$0} #{ARGV.join(" ")}" # rubocop:disable Style/SpecialGlobalVars
+        }
       end
 
       # @retrun [String] the name of the current environment
@@ -327,7 +329,9 @@ module Eco
         if mailer?
           mailer.mail(**kargs)
         else
-          logger.error("You are trying to use the mailer, but it's not configured")
+          log(:error) {
+            "You are trying to use the mailer, but it's not configured"
+          }
           nil
         end
       end
@@ -353,12 +357,17 @@ module Eco
           elsif directory
             path = s3uploader.upload_directory(directory, recurse: recurse)
           else
-            logger.error("To use Session.s3upload, you must specify either directory, file or content and file name")
+            log(:error) {
+              "To use Session.s3upload, you must specify either directory, file or content and file name"
+            }
           end
           return path unless link
+
           s3uploader.link(path)
         else
-          logger.error("You are trying to use S3 uploader, but it's not configured")
+          log(:error) {
+            "You are trying to use S3 uploader, but it's not configured"
+          }
           nil
         end
       end

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

@@ -3,8 +3,12 @@ module Eco
   module API
     class UseCases
       class Cli
+        extend Eco::API::Common::ClassHelpers
+
         require_relative 'cli/dsl'
         extend DSL
+
+        inheritable_class_vars :description, :cli_name, :callback, :options
       end
     end
   end

data/lib/eco/api/usecases/default/locations/cli/codes_to_tags_cli.rb

@@ -0,0 +1,18 @@
+class Eco::API::UseCases::Default::Locations::CodesToTagsCase
+  # Class to define the CLI integration of a usecase anywhere it suits.
+  class Cli < Eco::API::UseCases::Cli
+    str  = "Adds a column 'ecoPortalTag' to the input CSV "
+    str << "with the tags that the location codes map to"
+    desc str
+
+    callback do |_sess, options, _case|
+      file = SCR.get_file(cli_name, required: true, should_exist: true)
+      options.deep_merge!(other: {file: {name: file, format: :csv}})
+    end
+
+    add_option("-column", "Specify the input column header with the codes") do |options|
+      col_codes = SCR.get_arg("-column", with_param: true)
+      options.deep_merge!(other: {file: {codes_column: col_codes}})
+    end
+  end
+end

data/lib/eco/api/usecases/default/locations/cli/csv_to_tree_cli.rb

@@ -0,0 +1,12 @@
+class Eco::API::UseCases::Default::Locations::CsvToTree
+  # Class to define the CLI integration of a usecase anywhere it suits.
+  class Cli < Eco::API::UseCases::Cli
+    str  = "Creates a JSON file with the tagtree from a CSV file"
+    desc str
+
+    callback do |_sess, options, _case|
+      file = SCR.get_file(cli_name, required: true, should_exist: true)
+      options.deep_merge!(source: {file: file})
+    end
+  end
+end

data/lib/eco/api/usecases/default/locations/cli/tagtree_paths_cli.rb

@@ -0,0 +1,12 @@
+class Eco::API::UseCases::Default::Locations::TagTreePaths
+  # Class to define the CLI integration of a usecase anywhere it suits.
+  class Cli < Eco::API::UseCases::Cli
+    str  = "Creates a CSV with the paths to each tag"
+    desc str
+
+    add_option("-column", "Specify the input column header with the codes") do |options|
+      col_codes = SCR.get_arg("-column", with_param: true)
+      options.deep_merge!(other: {file: {codes_column: col_codes}})
+    end
+  end
+end

data/lib/eco/api/usecases/default/locations/codes_to_tags_case.rb

@@ -2,22 +2,30 @@ class Eco::API::UseCases::Default::Locations::CodesToTagsCase < Eco::API::Common
   name "codes-to-tags-from"
   type :other
 
+  require_relative 'cli/codes_to_tags_cli'
+
+  def main(*_args)
+    options[:end_get] = false
+    codes_to_tags
+  end
+
   def codes_to_tags
-    raise "You have not defined a tagtree for the organisation" unless session.tagtree
+    msg = "You have not defined a tagtree for the organisation"
+    raise msg unless session.tagtree
+
     csv_table = Eco::CSV.read(input_file)
 
-    csv_table.add_column("ecoPortalTag").tap do |csv_table|
-      csv_table.each do |row|
+    csv_table.add_column("ecoPortalTag").tap do |table|
+      table.each do |row|
         row["ecoPortalTag"] = to_tag(row[codes_column])
       end
 
-      File.open(output_file, "w") {|fd| fd << csv_table.to_csv}
-    end
-  end
+      File.open(output_file, "w") {|fd| fd << table.to_csv}
 
-  def main(session, options, usecase)
-    options[:end_get] = false
-    codes_to_tags
+      log(:info) {
+        "Generated '#{output_file}' file"
+      }
+    end
   end
 
   private
@@ -28,15 +36,22 @@ class Eco::API::UseCases::Default::Locations::CodesToTagsCase < Eco::API::Common
     elsif session.tagtree.tag?(code)
       code.upcase
     else
-      logger.warn("Unknown Location Code: '#{code}'")
+      log(:warn) { "Unknown Location Code: '#{code}'" }
       nil
     end
   end
 
   def mapper
-    unless mapper ||= session.config.location_codes && session.config.locations_mapper
-      raise "No filter_tags parser, nor location mappings are present"
+    return @mapper if instance_variable_defined?(:@mapper)
+
+    @mapper = session.config.locations_mapper if session.config.location_codes
+
+    unless @mapper
+      msg = "No filter_tags parser, nor location mappings are present"
+      raise msg
     end
+
+    @mapper
   end
 
   def codes_column
@@ -48,7 +63,11 @@ class Eco::API::UseCases::Default::Locations::CodesToTagsCase < Eco::API::Common
   end
 
   def output_file
-    "mapped_#{clean_file_name(input_file)}"
+    File.join(output_folder, "mapped_#{clean_file_name(input_file)}")
+  end
+
+  def output_folder
+    File.dirname(input_file)
   end
 
   def clean_file_name(filename)