eco-helpers 3.0.21 → 3.0.23

data/lib/eco/api/usecases/default/people/treat/analyse_people_case.rb

@@ -4,9 +4,7 @@ class Eco::API::UseCases::Default::People::Treat::Analyse < Eco::API::Common::Lo
 
   require_relative 'cli/analyse_people_cli'
 
-  attr_reader :people
-
-  def main(_people, _session, options, _usecase)
+  def main(*_args)
     options[:end_get] = false
 
     if case_options[:identify_duplicates]
@@ -97,7 +95,12 @@ class Eco::API::UseCases::Default::People::Treat::Analyse < Eco::API::Common::Lo
     opts.deep_merge!(export: {options: {internal_names: true}})
     # opts.deep_merge!(export: {options: {split_schemas: true}})
 
-    session.process_case("to-csv", type: :export, people: data, options: opts.merge(options.slice(:export)))
+    session.process_case(
+      'to-csv',
+      type:   :export,
+      data:    data,
+      options: opts.merge(options.slice(:export))
+    )
   end
 
   def unique_words?

data/lib/eco/api/usecases/default/people/treat/supers_cyclic_identify_case.rb

@@ -8,9 +8,7 @@ class Eco::API::UseCases::Default::People::Treat::SupersCyclicIdentify < Eco::AP
   OUT_TIME_FORMAT = '%Y%m%dT%H%M%S'.freeze
   OUT_FILENAME    = "cyclic_supers".freeze
 
-  attr_reader :people
-
-  def main(_people, _session, options, _usecase)
+  def main(*_args)
     options[:end_get] = false
     save!(cyclic_sets)
   end

data/lib/eco/api/usecases/default/people/treat/supers_hierarchy_case.rb

@@ -8,12 +8,8 @@ class Eco::API::UseCases::Default::People::Treat::SupersHierarchy < Eco::API::Co
   OUT_TIME_FORMAT = '%Y%m%dT%H%M%S'.freeze
   OUT_FILENAME    = "supers_hierarchy".freeze
 
-  attr_reader :people
-
-  def main(people, _session, options, _usecase)
+  def main(*_args)
     options[:end_get] = false
-    @people = people
-
     save!(hierarchy, file: output_filename)
   end
 

data/lib/eco/api/usecases/default_cases/entries_to_csv_case.rb

@@ -2,8 +2,8 @@ class Eco::API::UseCases::DefaultCases::EntriesToCsv < Eco::API::Common::Loaders
   name "entries-to-csv"
   type :import
 
-  def main(entries, session, options, usecase)
-    entries.export(filename)
+  def main(*_args)
+    input.export(filename)
   end
 
   private

data/lib/eco/api/usecases/default_cases/hris_case.rb

@@ -3,10 +3,8 @@ class Eco::API::UseCases::DefaultCases::HrisCase < Eco::API::Common::Loaders::Us
   type :sync
 
   attr_reader :creation, :update, :supers, :leavers
-  attr_reader :people
 
   def main(entries, people, session, options, usecase)
-    @people = people
     require_only_one_schema!
     micro     = session.micro
     @leavers  = session.new_job("pre", "leavers",  :update, usecase, :account)

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

@@ -0,0 +1,3 @@
+class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::UseCases::Samples::Drivers::Sftp
+end
+

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

@@ -9,4 +9,4 @@ module Eco
   end
 end
 
-require_relative 'samples/sftp_case'
+require_relative 'samples/sftp'

data/lib/eco/api/usecases/default_cases/to_csv_case.rb

@@ -4,11 +4,8 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
 
   OUT_FILENAME = 'pm'.freeze
 
-  attr_reader :people
-
   def main(people, _session, options, _usecase)
     options[:end_get] = false
-    @people = people
 
     unless people && !people.empty?
       log(:warn) { "No source people to create the file... aborting!" }
@@ -113,9 +110,9 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
 
   def by_schema
     people.group_by do |person|
-      if (details = person.details)
-        details.schema_id
-      end
+      next unless (details = person.details)
+
+      details.schema_id
     end.transform_values do |persons|
       people.newFrom persons
     end

data/lib/eco/api/usecases/graphql/base.rb

@@ -2,13 +2,13 @@ class Eco::API::UseCases::GraphQL::Base < Eco::API::Common::Loaders::UseCase
   class NotImplementedMethod < StandardError
   end
 
-  name "graphql-base"
+  name 'graphql-base'
   type :other
 
   include Eco::API::UseCases::GraphQL::Helpers::Base
   include Eco::Language::Methods::CallDetector
 
-  def main(_sess, options, _case)
+  def main(*_args)
     options[:end_get] = false
     process
   end
@@ -16,6 +16,7 @@ class Eco::API::UseCases::GraphQL::Base < Eco::API::Common::Loaders::UseCase
   # Write here your script
   def process
     return unless called_via?(Eco::API::UseCases::GraphQL::Base, __method__)
+
     raise NotImplementedMethod, "You need to inherit from this class ('#{self.class}')"
   end
 end

data/lib/eco/api/usecases/graphql/helpers/base/case_env.rb

@@ -13,7 +13,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Base
     end
 
     def simulate?
-      options[:simulate]
+      options[:simulate] || options[:dry_run]
     end
   end
 end

data/lib/eco/api/usecases/graphql/helpers/base/error_handling.rb

@@ -32,9 +32,9 @@ module Eco::API::UseCases::GraphQL::Helpers::Base
     rescue StandardError => err
       self.exception ||= err
 
-      unless exception_already_captured?(err)
-        log(:error) { err.patch_full_message }
-      end
+      return unless exception_already_captured?(err)
+
+      log(:error) { err.patch_full_message }
     rescue SystemExit
       @exiting = true
       raise

data/lib/eco/api/usecases/graphql/helpers/contractors/base/load.rb

@@ -0,0 +1,17 @@
+module Eco::API::UseCases::GraphQL::Helpers::Contractors
+  module Base
+    module Load
+      include Eco::API::UseCases::GraphQL::Helpers::Base
+
+      def load_contractors
+        contractor_entities
+      end
+
+      private
+
+      def contractor_entities
+        graphql.currentOrganization.contractorEntities
+      end
+    end
+  end
+end

data/lib/eco/api/usecases/graphql/helpers/contractors/base.rb

@@ -0,0 +1,8 @@
+require_relative 'base/load'
+
+module Eco::API::UseCases::GraphQL::Helpers::Contractors
+  module Base
+    include Eco::API::UseCases::GraphQL::Helpers::Base
+    include Load
+  end
+end

data/lib/eco/api/usecases/graphql/helpers/contractors.rb

@@ -0,0 +1,6 @@
+module Eco::API::UseCases::GraphQL::Helpers
+  module Contractors
+  end
+end
+
+require_relative 'contractors/base'

data/lib/eco/api/usecases/graphql/helpers/location/base.rb

@@ -14,9 +14,9 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
       @target_structure_id ||= current_tree.id if current_tree.respond_to?(:id)
       return @target_structure_id if @target_structure_id
 
-      msg  = "Const TARGET_STRUCTURE_ID has not been defined, "
-      msg << "nor options(:source, :structure_id). "
-      msg << "Infering active locations structure."
+      msg  = 'Const TARGET_STRUCTURE_ID has not been defined, '
+      msg << 'nor options(:source, :structure_id). '
+      msg << 'Infering active locations structure.'
       log(:warn) { msg }
 
       # a backup happens:
@@ -51,7 +51,8 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
     end
 
     def target_structure_id_const
-      return nil unless self.class.const_defined?(:TARGET_STRUCTURE_ID)
+      return unless self.class.const_defined?(:TARGET_STRUCTURE_ID)
+
       self.class.const_get(:TARGET_STRUCTURE_ID)
     end
   end

data/lib/eco/api/usecases/graphql/helpers/location/command.rb

@@ -15,7 +15,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
     # @param commands [Array<Hash>]
     def input(commands, force_continue: force_continue?)
       {
-        clientMutationId: "",
+        clientMutationId: '',
         id:               target_structure_id,
         force:            force_continue,
         commands:         commands
@@ -34,7 +34,7 @@ module Eco::API::UseCases::GraphQL::Helpers::Location
 
       if batch_input[:commands].empty?
         msg  = "#{dry_run_msg}No commands for '#{desc}'."
-        msg << " Skipping batch..." unless simulate?
+        msg << ' Skipping batch...' unless simulate?
         log(:info) { msg }
 
         return

data/lib/eco/api/usecases/graphql/helpers.rb

@@ -5,3 +5,4 @@ end
 
 require_relative 'helpers/base'
 require_relative 'helpers/location'
+require_relative 'helpers/contractors'

data/lib/eco/api/usecases/graphql/samples/contractors/dsl.rb

@@ -0,0 +1,5 @@
+module Eco::API::UseCases::GraphQL::Samples
+  module Contractors::DSL
+    include Eco::API::UseCases::GraphQL::Helpers::Contractors::Base
+  end
+end

data/lib/eco/api/usecases/graphql/samples/contractors.rb

@@ -0,0 +1,17 @@
+module Eco::API::UseCases::GraphQL
+  class Samples::Contractors < Eco::API::UseCases::GraphQL::Base
+    name 'contractors_base'
+    target_model :contractors
+
+    require_relative 'contractors/dsl'
+    include Eco::API::UseCases::GraphQL::Samples::Contractors::DSL
+
+    def main(*_args)
+      options[:end_get] = false
+    end
+
+    def process
+      raise 'Please do not use this method with contractor use cases. Use main'
+    end
+  end
+end

data/lib/eco/api/usecases/graphql/samples/location/service/base.rb

@@ -1,9 +1,9 @@
+# @todo maybe delete, it isn't being used anywhere
 module Eco::API::UseCases::GraphQL::Samples
   module Location::Service
     # Base class to create service classes that work like a use case
     class Base
       include Eco::API::UseCases::GraphQL::Samples::Location::DSL
-
     end
   end
 end

data/lib/eco/api/usecases/graphql/samples/location.rb

@@ -1,6 +1,6 @@
 module Eco::API::UseCases::GraphQL
   class Samples::Location < Eco::API::UseCases::GraphQL::Base
-    name "location-base"
+    name 'location-base'
 
     require_relative 'location/dsl'
     include Eco::API::UseCases::GraphQL::Samples::Location::DSL

data/lib/eco/api/usecases/graphql/samples.rb

@@ -4,3 +4,4 @@ module Eco::API::UseCases::GraphQL
 end
 
 require_relative 'samples/location'
+require_relative 'samples/contractors'

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

@@ -211,7 +211,6 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
       return
     end
 
-    patch = patch_doc(ooze)
     # store the request
     File.open(SAVE_PATCH, "w") do |file|
       #file << (patch_doc || {}).to_json

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

@@ -1,9 +1,9 @@
 # Base class to run a script against a single ooze.
 class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::UseCases::OozeSamples::OozeBaseCase
-  name "ooze-run-base"
+  name 'ooze-run-base'
   type :other
 
-  SAVE_PATCH = "ooze_patch_update.json".freeze
+  SAVE_PATCH = 'ooze_patch_update.json'.freeze
 
   def main(session, options, usecase)
     super(session, options, usecase) do
@@ -21,8 +21,8 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::UseCases::Ooz
     end
   end
 
-  def process_ooze(page = target)
-    raise "You need to redefine this method"
+  def process_ooze(_page = target)
+    raise 'You need to redefine this method'
   end
 
   private
@@ -50,15 +50,15 @@ class Eco::API::UseCases::OozeSamples::OozeRunBaseCase < Eco::API::UseCases::Ooz
   end
 
   def exit_if_no_changes!
-    return if !!patch_doc["page"]
+    return unless patch_doc['page'].nil?
 
-    log(:info) { "No Changes!!" }
+    log(:info) { 'No Changes!!' }
     exit(0)
   end
 
   def prompt_to_confirm!
-    micro.prompt_user("Do you want to proceed (y/N)?", default: "Y") do |response|
-      exit(1) unless response.upcase.start_with?("Y")
+    micro.prompt_user('Do you want to proceed (y/N)?', default: 'Y') do |response|
+      exit(1) unless response.upcase.start_with?('Y')
     end
   end
 end

data/lib/eco/api/usecases/{default_cases/samples → samples/drivers}/cli/sftp_cli.rb

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::DefaultCases::Samples::Sftp
+class  Eco::API::UseCases::Samples::Drivers::Sftp
   class Cli < Eco::API::UseCases::Cli
     desc "SFTP case: manages remote files that match a file pattern"
 

data/lib/eco/api/usecases/samples/drivers/cli/url_pull_cli.rb

@@ -0,0 +1,15 @@
+class Eco::API::UseCases::Samples::Drivers::UrlPull
+  class Cli < Eco::API::UseCases::Cli
+    desc "Url Pull sample: pull the file from a specific URL"
+
+    add_option("-target-url-const", "Constant that should be used as a pattern") do |options|
+      url_const = SCR.get_arg("-target-url-const", with_param: true)
+      options.deep_merge!(url_pull: {target_url_const: url_const})
+    end
+
+    add_option("-local-folder", "Local folder to pull the remote files to.") do |options|
+      local_folder = SCR.get_file("-local-folder", required: true, should_exist: true)
+      options.deep_merge!(url_pull: {local_folder: local_folder})
+    end
+  end
+end

data/lib/eco/api/usecases/{default_cases/samples/sftp_case.rb → samples/drivers/sftp_sample.rb}

@@ -1,17 +1,17 @@
 # rubocop:disable Naming/AccessorMethodName
-class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Samples::Drivers::Sftp < Eco::API::Common::Loaders::UseCase
   class WrongConst < ArgumentError; end
   class MissRemoteFolder < ArgumentError; end
 
   require_relative 'cli/sftp_cli'
-  name "sftp"
+  name 'sftp'
   type :other
 
   CONST_REFERRAL = /^(?:::)?(?:[A-Z][a-zA-Z0-9_]*(?:::[A-Z][a-zA-Z0-9_]*)*)$/
 
   def main(session, options, _usecase)
     options[:end_get] = false
-    raise "The SFTP is not configured" unless session.sftp?
+    raise 'The SFTP is not configured' unless session.sftp?
 
     case options.dig(:sftp, :command)
     when :list
@@ -34,7 +34,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
     return     unless require
 
     msg  = "(#{self.class}) You should redefine the file_pattern function "
-    msg << "as a RegEx expression that matches the target remote file"
+    msg << 'as a RegEx expression that matches the target remote file'
     raise WrongConst, msg
   end
 
@@ -52,7 +52,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
     raise WrongConst, "(#{self.class}) Unknown constant: #{fpc}"
   end
 
-  # Ex: "/IN/Personnel"
+  # Ex: '/IN/Personnel'
   def remote_subfolder(require: true)
     rm_sf = options.dig(:sftp, :remote_subfolder)
 
@@ -60,7 +60,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
     return unless require
 
     msg  = "(#{self.class}) You should redefine remote_subfolder "
-    msg << "as the folder where the target file sits. Ex: /IN/Personnel"
+    msg << 'as the folder where the target file sits. Ex: /IN/Personnel'
     raise MissRemoteFolder, msg
   end
 
@@ -77,7 +77,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
   end
 
   def local_folder
-    options.dig(:sftp, :local_folder) || "."
+    options.dig(:sftp, :local_folder) || '.'
   end
 
   def with_remote_files(folder: remote_folder, pattern: file_pattern)
@@ -147,7 +147,7 @@ class Eco::API::UseCases::DefaultCases::Samples::Sftp < Eco::API::Common::Loader
   end
 
   def archive_subfolder
-    "Archive"
+    'Archive'
   end
 
   def sftp_config

data/lib/eco/api/usecases/samples/drivers/url_pull_sample.rb

@@ -0,0 +1,110 @@
+class Eco::API::UseCases::Samples::Drivers::UrlPull < Eco::API::Common::Loaders::UseCase
+  class WrongConst < ArgumentError; end
+  # class MissRemoteFolder < ArgumentError; end
+
+  require_relative 'cli/url_pull_cli'
+  name 'url-pull'
+  type :other
+
+  CONST_REFERRAL = /^(?:::)?(?:[A-Z][a-zA-Z0-9_]*(?:::[A-Z][a-zA-Z0-9_]*)*)$/
+
+  def main(*_args)
+    options[:end_get] = false
+    require_dependencies
+
+    if (response = get(URI(target_url), **auth_params))
+      to_csv(response.body, out_filename)
+    else
+      log(:error) { "Could not pull from url: #{target_url}" }
+      exit 1
+    end
+  end
+
+  private
+
+  def require_dependencies
+    require 'net/http'
+    require 'uri'
+    require 'csv'
+    # require 'dotenv/load'
+  end
+
+  # Override this method to obtain authentication
+  # i.e. { user: ENV['KEY']}
+  def auth_params
+    {}
+  end
+
+  def get(uri, **kargs)
+    base_request(uri, **kargs) do |request|
+      http_start(uri) do |http|
+        puts "Pulling from url: #{uri}"
+        return http.request(request)
+      end
+    end
+  end
+
+  def to_csv(plain_data, filename)
+    data = CSV.parse(plain_data)
+
+    CSV.open(filename, 'w') do |csv|
+      data.each do |line|
+        csv << line
+      end
+    end
+
+    log(:info) { "Generated output file: #{filename}" }
+  end
+
+  def request_options(uri)
+    {
+      use_ssl: uri.scheme == 'https'
+    }
+  end
+
+  def http_start(uri, &block)
+    Net::HTTP.start(uri.hostname, uri.port, request_options(uri), &block)
+  end
+
+  def base_request(uri, user: nil, pass: '')
+    Net::HTTP::Get.new(uri).tap do |request|
+      request.basic_auth(user, pass) unless user.nil?
+      yield(request)
+    end
+  end
+
+  def out_filename
+    File.join(local_folder, "#{file_basename}.csv")
+  end
+
+  def file_basename
+    config.active_enviro
+  end
+
+  def local_folder
+    options.dig(:url_pull, :local_folder) || '.'
+  end
+
+  def target_url(required: true)
+    fpc = target_url_const
+    return fpc if fpc
+    return     unless required
+
+    msg = "(#{self.class}) You should redefine the target_url method "
+    raise WrongConst, msg
+  end
+
+  def target_url_const
+    if (fpc = options.dig(:url_pull, :target_url_const))
+      raise WrongConst, "(#{self.class}) Invalid file pattern const referral: #{fpc}" unless fpc.match(CONST_REFERRAL)
+
+      begin
+        self.eval(fpc)
+      rescue NameError
+        self.class.const_get(fpc)
+      end
+    end
+  rescue NameError
+    raise WrongConst, "(#{self.class}) Unknown constant: #{fpc}"
+  end
+end

data/lib/eco/api/usecases/samples/drivers.rb

@@ -0,0 +1,13 @@
+module Eco
+  module API
+    class UseCases
+      class Samples
+        module Drivers
+        end
+      end
+    end
+  end
+end
+
+require_relative 'drivers/sftp_sample'
+require_relative 'drivers/url_pull_sample'

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

@@ -0,0 +1,11 @@
+module Eco
+  module API
+    class UseCases
+      class Samples < Eco::API::UseCases
+      end
+    end
+  end
+end
+
+require_relative 'samples/drivers'
+

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

@@ -0,0 +1,12 @@
+class Eco::API::UseCases::UseCase
+  module Chainer
+    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
+      Eco::API::UseCases::UseCaseChain.new(
+        usecase: self,
+        root:    @root
+      )
+    end
+  end
+end