eco-helpers 2.0.21 → 2.0.26

data/lib/eco/cli/config/default/input.rb

@@ -1,19 +1,72 @@
 ASSETS.cli.config do |cnf|
+  formats = {
+    csv: {
+      option: ["-csv"],
+      extname: [".csv", ".txt"]
+    },
+    xml: {
+      option: ["-xml"],
+      extname: [".xml"]
+    },
+    xls:  {
+      option: ["-xls", "-xlsx", "-excel"],
+      extname: [".xls", ".xlsx", ".xlsm"]
+    },
+    json: {
+      option: ["-json"],
+      extname: [".json"]
+    }
+  }
+
   cnf.input(default_option: "-entries-from") do |session, str_opt, options|
     input = []
     if SCR.get_arg(str_opt)
       file = SCR.get_file(str_opt, required: true)
-      options.deep_merge!(input: {file: {name: file}})
-      if SCR.get_arg("-xml")
-        options.deep_merge!(input: {file: {format: :xml}})
-        session.config.files.validate(:xml, file)
-        input = session.entries(file: file, format: :xml)
-      elsif SCR.get_arg("-json")
-        options.deep_merge!(input: {file: {format: :json}})
-        input = Eco::API::Organization::People.new(JSON.parse(File.read(file)))
+
+      # Command line check
+      format = formats.reduce(nil) do |matched, (format, selectors)|
+        used = selectors[:option].reduce(false) {|used, option| SCR.get_arg(option) || used}
+        next matched if matched
+        next format  if used
+      end
+
+      # File/Folder check
+      file = File.expand_path(file)
+      if File.directory?(file)
+        folder = file
+        file   = Dir.glob("#{file}/*").reject {|f| File.directory?(f)}
+        ext    = (format && formats[format][:extname]) || [File.extname(file.first)]
+        file   = file.select {|f| ext.any? {|e| File.extname(f) == e}}.tap do |files|
+          if files.empty?
+            session.logger.error("Could not find any file with extension: #{ext} in folder '#{folder}'")
+            exit(1)
+          end
+        end
       else
-        options.deep_merge!(input: {file: {format: :csv}})
-        input = session.csv_entries(file)
+        ext    = File.extname(file)
+      end
+
+      format ||= formats.reduce(nil) do |matched, (format, selectors)|
+        next matched if matched
+        next format  if selectors[:extname].any? {|e| ext == e}
+      end
+      format ||= :csv
+
+      options.deep_merge!(input: {file: {name: file}})
+      options.deep_merge!(input: {file: {format: format}})
+
+      case format
+      when :xml
+        [file].flatten.each {|f| session.config.files.validate(:xml, f)}
+        input = session.entries(file: file, format: format)
+      when :xls
+        input = session.entries(file: file, format: format)
+      when :json
+        input = [file].flatten.reduce(Eco::API::Organization::People.new([])) do |people, file|
+          people.merge(JSON.parse(File.read(file)))
+        end
+      else # :csv
+        input = session.csv_entries(file, check_headers: true)
       end
     end
     input

data/lib/eco/cli/config/default/options.rb

@@ -1,19 +1,30 @@
 ASSETS.cli.config do |cnf|
   cnf.options_set do |options_set, options|
     options_set.add("--help", "Offers a HELP") do |options, sesssion|
-      conf = ASSETS.cli.config
-      puts conf.people_filters.help if hpf = SCR.get_arg("-filters")
-      puts conf.input_filters.help  if hif = SCR.get_arg("-input-filters")
-      puts conf.options_set.help    if ho  = SCR.get_arg("-options")
-      puts conf.usecases.help       if huc = SCR.get_arg("-usecases")
+      conf   = ASSETS.cli.config
+      active = Proc.new {|opt| SCR.get_arg(opt) && SCR.get_arg(opt, with_param: true)}
+
+      if hpf = active.call("-filters")
+        puts conf.people_filters.help(refine: hpf)
+      end
+      if hif = active.call("-input-filters")
+        puts conf.input_filters.help(refine: hif)
+      end
+      if ho  = active.call("-options")
+        puts conf.options_set.help(refine: ho)
+      end
+      if huc = active.call("-usecases")
+        puts conf.usecases.help(refine: huc)
+      end
       puts [
         "Please specify one of the below:",
         "  -filters       to display available filters on people",
         "  -input-filters to display available filters on input data",
         "  -options       to dislpay available options",
         "  -usecases      to display available usecases",
-        "",
-        "You may specify the usecase to know its specific options by: -usecase_name --help -options"
+        "TIPS:",
+        "  * You may specify the usecase to know its specific options by:    -usecase_name --help -options",
+        "  * You may specify a refinement to show specific information only: --help -usecases tags"
       ].join("\n") unless hpf || hif || ho || huc
       exit
     end
@@ -41,7 +52,7 @@ ASSETS.cli.config do |cnf|
       session.schema = sch_id
     end
 
-    desc  = "Used to be used to specify the input file when using -get-partial. "
+    desc  = "Used to be used to specify the input file or folder when using -get-partial."
     desc += "It can also be useful to obtain `-get-partial` of people base on `:export` use cases (i.e. -people-to-csv)"
     options_set.add("-entries-from", desc) do |options, session|
       options.deep_merge!(input: {entries_from: true})
@@ -66,6 +77,11 @@ ASSETS.cli.config do |cnf|
       })
     end
 
+    desc = "Saves the requests's body even though running in dry-run (-simulate)"
+    options_set.add("-save-requests", desc) do |options, session|
+      options.deep_merge!(requests: {backup: true})
+    end
+
     desc  = "Used to specify the cache file of people to be used. "
     desc += "It is useful to use as people reference those stored in cached file diffrent to the last one."
     options_set.add("-people-from-backup", desc) do |options, session|
@@ -82,6 +98,22 @@ ASSETS.cli.config do |cnf|
       session.config.dry_run!
     end
 
+    desc  = "Runs runs post_launch cases even if in dry-run"
+    options_set.add("-run-postlaunch", desc) do |options, session|
+      options.deep_merge!(post_launch: {run: true})
+    end
+
+    desc  = "(careful with this option)  This will include everybody as part of the update (including those that are api excluded). "
+    desc += "Only launch with this option when only api excluded people are included in your update."
+    options_set.add("-include-excluded", desc) do |options|
+      options.deep_merge!(include: {excluded: true})
+    end
+
+    desc = "Includes in API updates ONLY people that evaluate true as people excluded from periodic upates."
+    options_set.add("-include-only-excluded", desc) do |options|
+      options.deep_merge!(include: {excluded: {only: true}})
+    end
+
     desc = "Ignores threshold limitations on requests for this session (skip batch belt)"
     options_set.add("-skip-batch-policy", desc) do |options|
       options.deep_merge!(skip: {batch_policy: true})

data/lib/eco/cli/config/default/usecases.rb

@@ -190,9 +190,18 @@ ASSETS.cli.config do |cnf|
     cases.add("-set-default-tag", :transform, desc, case_name: "set-default-tag")
 
     desc = "Creates people with with details and account"
+    as1  = "During the run, if new people is created, they are included in the People object of the current session."
+    as1 << " This makes them available to find them (i.e. via 'external-id') before they exist"
     cases.add("-create-from", :sync, desc, case_name: "create")
+    .add_option("-append-starters", as1) do |options|
+      options.deep_merge!(people: {append_created: true})
+    end
+    
     desc = "Creates people with only details"
     cases.add("-create-details-from", :sync, desc, case_name: "create-details")
+    .add_option("-append-starters", as1) do |options|
+      options.deep_merge!(people: {append_created: true})
+    end
 
     desc = "It just adds everybody to an update job without doing any change. If the org has policies, it will refresh"
     cases.add("-refresh", :transform, desc, case_name: "refresh")
@@ -213,7 +222,14 @@ ASSETS.cli.config do |cnf|
 
     desc = "Tries to find the input entries and update them. It creates them if not found"
     cases.add("-upsert-from", :sync, desc, case_name: "upsert")
+    .add_option("-append-starters", as1) do |options|
+      options.deep_merge!(people: {append_created: true})
+    end
+
     desc = "It does like -upsert-from and additionally removes account and supervisor of those in people that are not in the entries (leavers)"
     cases.add("-hris-from", :sync, desc, case_name: "hris")
+    .add_option("-append-starters", as1) do |options|
+      options.deep_merge!(people: {append_created: true})
+    end
   end
 end

data/lib/eco/cli/config/default/workflow.rb

@@ -100,10 +100,13 @@ ASSETS.cli.config do |config|
       else
         get_people     = io.options.dig(:people, :get)
         partial_update = get_people && get_people.dig(:type) == :partial
-        if !io.options[:dry_run] && partial_update
-          # get target people afresh
-          people = io.session.micro.people_refresh(people: io.people, include_created: true)
-          io     = io.new(people: people)
+        run_it         = !io.options[:dry_run] || io.options.dig(:post_launch, :run)
+        if run_it && partial_update
+          unless io.options[:dry_run]
+            # get target people afresh
+            people = io.session.micro.people_refresh(people: io.people, include_created: true)
+            io     = io.base.new(people: people)
+          end
         else
           wf_post.skip!
           msg = "Although there are post_launch cases, they will NOT be RUN"

data/lib/eco/cli/config/filters.rb

@@ -12,10 +12,14 @@ module Eco
         end
 
         # @return [String] summary of the filters.
-        def help(msg = "The following are the available filters:")
+        def help(msg = nil, refine: nil)
+          refinement = refine.is_a?(String)? " (containing: '#{refine}')" : ""
+          msg ||= "The following are the available filters#{refinement}:"
           [msg].yield_self do |lines|
             max_len = keys_max_len(@filters.keys)
-            @filters.keys.sort.each do |key|
+            @filters.keys.sort.select do |key|
+              refine.is_a?(String) && key.include?(refine)
+            end.each do |key|
               lines << help_line(key, @description[key], max_len)
             end
             lines

data/lib/eco/cli/config/filters/input_filters.rb

@@ -4,8 +4,9 @@ module Eco
       class Filters
         class InputFilters < Eco::CLI::Config::Filters
 
-          def help
-            super("The following are the available filters on the input entries:")
+          def help(refine: nil)
+            refinement = refine.is_a?(String)? " (containing: '#{refine}')" : ""
+            super("The following are the available filters on the input entries#{refinement}:", refine: refine)
           end
 
           def process(io:)

data/lib/eco/cli/config/filters/people_filters.rb

@@ -4,8 +4,9 @@ module Eco
       class Filters
         class PeopleFilters < Eco::CLI::Config::Filters
 
-          def help
-            super("The following are the available filters on people:")
+          def help(refine: nil)
+            refinement = refine.is_a?(String)? " (containing: '#{refine}')" : ""
+            super("The following are the available filters on people#{refinement}:", refine: refine)
           end
 
           def process(io:)

data/lib/eco/cli/config/help.rb

@@ -3,7 +3,7 @@ module Eco
     class Config
       module Help
 
-        def help
+        def help(*args)
           raise "this needs to be reimplemented in the child class and return a string"
         end
 

data/lib/eco/cli/config/options_set.rb

@@ -14,17 +14,19 @@ module Eco
         end
 
         # @return [String] summary of the options.
-        def help
+        def help(refine: nil)
           indent = 2
           spaces = any_non_general_space_active? ? active_namespaces : namespaces
-
-          ["The following are the available options:"].yield_self do |lines|
+          refinement = refine.is_a?(String)? " (containing: '#{refine}')" : ""
+          ["The following are the available options#{refinement}:"].yield_self do |lines|
             max_len = keys_max_len(options_args(spaces)) + indent
             spaces.each do |namespace|
               is_general = (namespace == :general)
               str_indent = is_general ? "" : " " * indent
               lines << help_line(namespace, "", max_len) unless is_general
-              options_set(namespace).each do |arg, option|
+              options_set(namespace).select do |arg, option|
+                refine.is_a?(String) && option.name.include?(refine)
+              end.each do |arg, option|
                 lines << help_line(" " * indent + "#{option.name}", option.description, max_len)
               end
             end

data/lib/eco/cli/config/use_cases.rb

@@ -29,10 +29,13 @@ module Eco
         end
 
         # @return [String] summary of the use cases.
-        def help
-          ["The following are the available use cases:"].yield_self do |lines|
+        def help(refine: nil)
+          refinement = refine.is_a?(String)? " (containing: '#{refine}')" : ""
+          ["The following are the available use cases#{refinement}:"].yield_self do |lines|
             max_len = keys_max_len(@linked_cases.keys)
-            @linked_cases.keys.sort.each do |option_case|
+            @linked_cases.keys.sort.select do |key|
+              refine.is_a?(String) && key.include?(refine)
+            end.each do |option_case|
               lines << help_line(option_case, @linked_cases[option_case].description, max_len)
             end
             lines

data/lib/eco/cli/scripting/args_helpers.rb

@@ -75,10 +75,10 @@ module Eco
         def get_file(key, required: false, should_exist: true)
           filename = get_arg(key, with_param: true)
           if !filename && required
-            puts "You need to specify a file '#{key} file'"
+            puts "You need to specify a file or folder '#{key} file_or_folder'"
             exit(1)
           elsif !file_exists?(filename) && should_exist && required
-            puts "This file doesn't exist '#{filename}'"
+            puts "This file/folder doesn't exist '#{filename}'"
             exit(1)
           end
 

data/lib/eco/csv.rb

@@ -5,6 +5,7 @@ module Eco
 
     class << self
 
+      # @return [Eco::CSV::Table]
       def parse(data, **kargs, &block)
         kargs = {headers: true, skip_blanks: true}.merge(kargs)
         out = super(data, **kargs, &block).reject do |row|
@@ -14,6 +15,7 @@ module Eco
         Eco::CSV::Table.new(out)
       end
 
+      # @return [Eco::CSV::Table]
       def read(file, **kargs)
         kargs = {headers: true,  skip_blanks: true}.merge(kargs)
 

data/lib/eco/language/models/collection.rb

@@ -134,8 +134,11 @@ module Eco
           to_a.group_by(&block) if block
         end
 
-        def to_h(attr)
-          return {} if !attr
+        # By a specific `attr` or a block
+        # @note either one or the other should be present
+        def to_h(attr, &block)
+          return to_a.group_by(&block) if block
+          raise "And attr or a block are required. Given attr: #{attr}" unless attr
           to_a.group_by { |object| object.method(attr).call }
         end
         # @!endgroup

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.21"
+  VERSION = "2.0.26"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.21
+  version: 2.0.26
 platform: ruby
 authors:
 - Oscar Segura
@@ -350,26 +350,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: creek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.5.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.5.2
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.6'
 description: 
 email:
 - oscar@ecoportal.co.nz
@@ -389,12 +369,13 @@ files:
 - lib/eco-helpers.rb
 - lib/eco/api.rb
 - lib/eco/api/common.rb
-- lib/eco/api/common/base_loader.rb
 - lib/eco/api/common/class_auto_loader.rb
 - lib/eco/api/common/class_helpers.rb
 - lib/eco/api/common/class_hierarchy.rb
 - lib/eco/api/common/class_meta_basics.rb
 - lib/eco/api/common/loaders.rb
+- lib/eco/api/common/loaders/base.rb
+- lib/eco/api/common/loaders/case_base.rb
 - lib/eco/api/common/loaders/error_handler.rb
 - lib/eco/api/common/loaders/parser.rb
 - lib/eco/api/common/loaders/policy.rb
@@ -412,6 +393,7 @@ files:
 - lib/eco/api/common/people/default_parsers/policy_groups_parser.rb
 - lib/eco/api/common/people/default_parsers/select_parser.rb
 - lib/eco/api/common/people/default_parsers/send_invites_parser.rb
+- lib/eco/api/common/people/default_parsers/xls_parser.rb
 - lib/eco/api/common/people/entries.rb
 - lib/eco/api/common/people/entry_factory.rb
 - lib/eco/api/common/people/person_attribute_parser.rb

data/lib/eco/api/common/base_loader.rb

@@ -1,68 +0,0 @@
-module Eco
-  module API
-    module Common
-      class BaseLoader
-        extend Eco::API::Common::ClassHelpers
-
-        class << self
-          attr_writer :name, :type
-
-          # The name that this case, policy or error handler will have.
-          def name(value = nil)
-            name_only_once! if value
-            set_created_at!
-            return @name ||= self.to_s unless value
-            @name = value
-          end
-
-          # Sort order
-          def <=>(other)
-            created_at <=> other.created_at
-          end
-
-          # If still not set, it sets the `created_at` class timestamp.
-          def set_created_at!
-            @created_at = Time.now unless @created_at
-          end
-
-          # Class creation timestamp, to be able to load them in the order they were declared.
-          def created_at
-            @created_at ||= Time.now
-          end
-
-          # Prevent the same class to be re-opened/re-named
-          def name_only_once!
-            raise "You have already declared #{self} or you are trying to give it a name twice" if @name
-          end
-
-        end
-
-        # This method will be called when the BaseLoader is created
-        # @note
-        #   - this method should implement the loading logics for the given `Children` class.
-        def initialize
-          raise "You should implement this method"
-        end
-
-        def name
-          self.class.name
-        end
-
-        private
-
-        def session
-          @session ||= ASSETS.session
-        end
-
-        def micro
-          session.micro
-        end
-
-        def config
-          @config ||= ASSETS.config
-        end
-
-      end
-    end
-  end
-end