eco-helpers 0.9.2 → 0.9.3

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

@@ -0,0 +1,87 @@
+module Eco
+  class CLI
+    class Config
+      class UseCases
+
+        attr_reader :core_config
+
+        def initialize(core_config:)
+          @core_config  = core_config
+          @linked_cases = {}
+        end
+
+        def add(option_case, type, case_name: nil)
+          Eco::API::UseCases::UseCase.validate_type(type)
+          unless callback = block_given?? Proc.new : nil
+            raise "You must specify a valid 'case_name' when no block is provided" unless case_name
+            raise "'case_name' expected to be a String. Given: #{case_name.class}" unless case_name.is_a?(String)
+          end
+
+          @linked_cases[option_case] = {
+            type => {
+              casename: case_name,
+              callback: callback
+            }
+          }
+          self
+        end
+
+        def process(io:)
+          unless io && io.is_a?(Eco::API::UseCases::BaseIO)
+            raise "You need to provide Eco::API::UseCases::BaseIO object. Given: #{io.class}"
+          end
+
+          processed = false
+          @linked_cases.each do |option, types|
+            types.each do |type, data|
+              if SCR.get_arg(option)
+                processed = true
+                io        = solve_io(io: io, type: type, option: option)
+
+                usecase = nil
+                if case_name = data[:casename]
+                  usecase = io.session.usecases.case(case_name, type: type)
+                end
+
+                if callback = data[:callback]
+                  if usecase
+                    callback.call(*io.params)
+                  else
+                    usecase = callback.call(*io.params)
+                    unless usecase.is_a?(Eco::API::UseCases::UseCase)
+                      msg  = "When adding a usecase, without specifying 'case_name:', "
+                      msg += "the block that integrates usecase for cli option '#{option}'"
+                      msg += " must return an Eco::API::UseCases::UseCase object. It returns #{usecase.class}"
+                      raise msg
+                    end
+                  end
+                end
+
+                usecase.launch(io: io)
+              end
+            end
+          end
+          processed
+        end
+
+        private
+
+        def solve_io(io:, type:, option:)
+          params = io.params(keyed: true).merge(type: type)
+
+          if (!io.people || io.people.empty?) && io.class.people_required?(type)
+            params.merge!(people: core_config.people)
+          end
+
+          if (!io.input || io.input.empty?) && io.class.input_required?(type)
+            input = core_config.input.get(io: io, option: option)
+            params.merge!(input: input)
+          end
+
+          io.new(**params)
+        end
+
+      end
+    end
+  end
+end

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

@@ -4,16 +4,22 @@ module Eco
       module ArgsHelpers
 
         def is_modifier?(value)
-         value&.start_with?("-")
+          Argument.is_modifier?(value)
         end
 
         def arguments
           @arguments ||= Arguments.new
         end
 
-        def stop_on_unknown!(exclude: [])
-          if arguments.any_unkown?(exclude: exclude)
-            raise "There are unknown options in your command line arguments: #{arguments.unknown(exclude: exclude)}"
+        def stop_on_unknown!(exclude: [], only_options: false)
+          # validate only those that are options
+          unknown = arguments.unknown(exclude: exclude)
+          if only_options
+            unknown = unknown..select {|arg| is_modifier?(arg)}
+          end
+
+          unless unknown.empty?
+            raise "There are unknown options in your command line arguments: #{unknown}"
           end
         end
 

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

@@ -5,6 +5,12 @@ module Eco
 
         attr_reader :key
 
+        class << self
+          def is_modifier?(value)
+           value&.start_with?("-")
+          end
+        end
+
         def initialize(key, with_param: false)
           @key        = key
           @with_param = !!with_param

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

@@ -50,6 +50,7 @@ module Eco
         end
 
         def merge(data)
+          data = data.to_a unless data.is_a?(Array)
           newFrom to_a + data
         end
 

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Oscar Segura
@@ -235,6 +235,7 @@ files:
 - lib/eco-helpers.rb
 - lib/eco/api.rb
 - lib/eco/api/common.rb
+- lib/eco/api/common/class_helpers.rb
 - lib/eco/api/common/people.rb
 - lib/eco/api/common/people/base_parser.rb
 - lib/eco/api/common/people/default_parsers.rb
@@ -246,6 +247,7 @@ files:
 - lib/eco/api/common/people/default_parsers/select_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
 - lib/eco/api/common/people/person_entry.rb
 - lib/eco/api/common/people/person_entry_attribute_mapper.rb
 - lib/eco/api/common/people/person_factory.rb
@@ -259,10 +261,16 @@ files:
 - lib/eco/api/common/session/mailer.rb
 - lib/eco/api/common/session/s3_uploader.rb
 - lib/eco/api/common/version_patches.rb
-- lib/eco/api/common/version_patches/base_model.rb
-- lib/eco/api/common/version_patches/external_person.rb
-- lib/eco/api/common/version_patches/internal_person.rb
+- lib/eco/api/common/version_patches/ecoportal_api.rb
+- lib/eco/api/common/version_patches/ecoportal_api/base_model.rb
+- lib/eco/api/common/version_patches/ecoportal_api/external_person.rb
+- lib/eco/api/common/version_patches/ecoportal_api/internal_person.rb
+- lib/eco/api/common/version_patches/hash.rb
+- lib/eco/api/common/version_patches/hash/deep_merge.rb
 - lib/eco/api/eco_faker.rb
+- lib/eco/api/error.rb
+- lib/eco/api/error/handler.rb
+- lib/eco/api/error/handlers.rb
 - lib/eco/api/organization.rb
 - lib/eco/api/organization/people.rb
 - lib/eco/api/organization/person_schemas.rb
@@ -273,14 +281,14 @@ files:
 - lib/eco/api/organization/presets_values.json
 - lib/eco/api/organization/tag_tree.rb
 - lib/eco/api/policies.rb
-- lib/eco/api/policies/base_policy.rb
 - lib/eco/api/policies/policy.rb
-- lib/eco/api/policies/used_policies.rb
 - lib/eco/api/session.rb
 - lib/eco/api/session/batch.rb
-- lib/eco/api/session/batch_job.rb
-- lib/eco/api/session/batch_jobs.rb
-- lib/eco/api/session/batch_status.rb
+- lib/eco/api/session/batch/errors.rb
+- lib/eco/api/session/batch/job.rb
+- lib/eco/api/session/batch/jobs.rb
+- lib/eco/api/session/batch/jobs_groups.rb
+- lib/eco/api/session/batch/status.rb
 - lib/eco/api/session/config.rb
 - lib/eco/api/session/config/api.rb
 - lib/eco/api/session/config/apis.rb
@@ -289,11 +297,14 @@ files:
 - lib/eco/api/session/config/logger.rb
 - lib/eco/api/session/config/mailer.rb
 - lib/eco/api/session/config/people.rb
+- lib/eco/api/session/config/post_launch.rb
 - lib/eco/api/session/config/s3_storage.rb
-- lib/eco/api/session/job_groups.rb
+- lib/eco/api/session/config/workflow.rb
 - lib/eco/api/session/task.rb
 - lib/eco/api/usecases.rb
 - lib/eco/api/usecases/base_case.rb
+- lib/eco/api/usecases/base_io.rb
+- lib/eco/api/usecases/default_case.rb
 - lib/eco/api/usecases/default_cases.rb
 - lib/eco/api/usecases/default_cases/change_email_case.rb
 - lib/eco/api/usecases/default_cases/create_case.rb
@@ -320,12 +331,21 @@ files:
 - lib/eco/api/usecases/use_case.rb
 - lib/eco/api/usecases/use_case_chain.rb
 - lib/eco/api/usecases/use_case_io.rb
-- lib/eco/api/usecases/use_group.rb
 - lib/eco/assets.rb
 - lib/eco/assets/language.rb
 - lib/eco/cli.rb
 - lib/eco/cli/config.rb
-- lib/eco/cli/config/options.rb
+- lib/eco/cli/config/default.rb
+- lib/eco/cli/config/default/filters.rb
+- lib/eco/cli/config/default/input.rb
+- lib/eco/cli/config/default/options.rb
+- lib/eco/cli/config/default/people.rb
+- lib/eco/cli/config/default/usecases.rb
+- lib/eco/cli/config/default/workflow.rb
+- lib/eco/cli/config/input.rb
+- lib/eco/cli/config/options_set.rb
+- lib/eco/cli/config/people_filters.rb
+- lib/eco/cli/config/use_cases.rb
 - lib/eco/cli/scripting.rb
 - lib/eco/cli/scripting/args_helpers.rb
 - lib/eco/cli/scripting/argument.rb

data/lib/eco/api/policies/base_policy.rb

@@ -1,14 +0,0 @@
-module Eco
-  module API
-    module Policies
-      class BasePolicy < Eco::API::UseCases::BaseCase
-
-        def initialize(policies, **options)
-          raise "Expected UsedPolicies. Given: #{policies.class}" unless policies.is_a?(UsedPolicies)
-          super(policies, **options)
-        end
-
-      end
-    end
-  end
-end

data/lib/eco/api/policies/used_policies.rb

@@ -1,37 +0,0 @@
-module Eco
-  module API
-    module Policies
-      class UsedPolicies < Eco::API::UseCases::UseGroup
-
-        attr_reader :policies
-
-        def add(policy)
-          raise "Expected Policy object. Given: #{policy}" if !policy || !policy.is_a?(Policy)
-          super(policy)
-        end
-
-        def define(name, type: :transform, &block)
-          Policy.new(name, type: type, root: self, &block).tap do |policy|
-            add(policy)
-          end
-        end
-
-        # TODO: decide if policies deal with queue or single person
-        def launch(people:, session:, options: {})
-
-          args = {
-            people:  people,
-            session: session,
-            options: options
-          }
-
-          items.map do |policy|
-            session.logger.debug("UsedPolicies: going to process '#{policy.name}' policy")
-            policy.launch(**args)
-          end
-        end
-      end
-
-    end
-  end
-end

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

@@ -1,215 +0,0 @@
-module Eco
-  module API
-    class Session
-      class BatchJob < API::Common::Session::BaseSession
-        TYPES = [:get, :create, :update, :delete]
-        SETS  = [:core, :details, :account]
-
-        class << self
-          def valid_type?(value)
-            TYPES.include?(value)
-          end
-
-          def valid_sets?(value)
-            sets = [value].flatten
-            sets.all? { |s| SETS.include?(s) }
-          end
-        end
-
-        attr_reader :name, :status
-        attr_reader :usecase
-
-        def initialize(e, name:, type:, sets:, usecase: nil)
-          raise "A name is required to refer a job. Given: #{name}" if !name
-          raise "Type should be one of #{TYPES}. Given: #{type}"    if !self.class.valid_type?(type)
-          raise "Sets should be some of #{SETS}. Given: #{sets}"    if !self.class.valid_sets?(sets)
-          raise "usecase must be a Eco::API::UseCases::UseCase object. Given: #{usecase.class}" if usecase && !usecase.is_a?(Eco::API::UseCases::UseCase)
-          super(e)
-
-          @name    = name
-          @type    = type
-          @usecase = usecase
-          @sets    = [sets].flatten.compact
-          reset
-        end
-
-        def reset
-          @queue      = []
-          @queue_hash = {}
-          @callbacks  = {}
-          @status     = nil
-        end
-
-        def usecase?
-          !!usecase
-        end
-
-        def signature
-          "job \"#{name}\" ['#{@type.to_s.upcase}': #{sets_title}]"
-        end
-
-        def match?(type:, sets:)
-          sets = [sets].flatten
-          type == @type && (sets.order == @sets.order)
-        end
-
-        def pending?
-          !@status
-        end
-
-        def core?
-          sets.include?(:core)
-        end
-
-        def details?
-          sets.include?(:details)
-        end
-
-        def account?
-          sets.include?(:account)
-        end
-
-        # Adds an entry to the job queue.
-        # @param entry [Person] the person we want to update, carrying the changes to be done.
-        # @param unique [Boolean] specifies if repeated entries should be avoided in the queue.
-        # @yield [person] callback before launching the batch job request against the server.
-        # @yeldparam param [Person] current person object that that should be treated by the callback before launching the batch.
-        # @return [Void]
-        def add(entry, unique: true)
-          unless !entry
-            unless unique && @queue_hash.key?(entry)
-              @queue_hash[entry] = true
-              @queue.push(entry)
-              @callbacks[entry] = Proc.new if block_given?
-            end
-          end
-        end
-
-        def people(input = @queue)
-          Eco::API::Organization::People.new(input)
-        end
-
-        def processed_queue
-          pre_queue = @queue.map do |e|
-            if callback = @callbacks[e]
-              callback.call(e)
-            end
-            e = nil if as_update(e).empty?
-            e
-          end.compact
-          apply_policies(pre_queue)
-        end
-
-        def processed_queue
-          @queue.each {|e| @callbacks[e].call(e) if @callbacks.key?(e) }
-          apply_policies(@queue).select {|e| !as_update(e).empty?}
-        end
-
-        def launch(simulate: false)
-          queue = processed_queue
-          launch_feedback(queue, simulate ? 2500 : 800)
-
-          if !simulate
-            if queue.length > 0
-              backup_update(queue)
-              @status = session.batch.launch(queue, method: @type)
-              @status.root = self
-            end
-          end
-
-          post_launch(queue: queue, simulate: simulate)
-
-          logger.info("Simulate: this would have launched: '#{@type}'") if simulate
-          return @status
-        end
-
-
-        private
-
-        def post_launch(queue: [], simulate: false)
-          if !simulate && @status
-            @status.queue.map do |entry|
-              if @status.success?(entry)
-                entry.consolidate! if entry.respond_to?(:consolidate!)
-              #else # shouldn't probably reset, as the model should remain dirty? (well tracaked)
-              #  entry.reset!       if entry.respond_to?(:reset!)
-              end
-            end
-          elsif simulate
-            queue.map do |entry|
-              entry.consolidate! if entry.respond_to?(:consolidate!)
-            end
-          end
-        end
-
-        def apply_policies(pre_queue)
-          pre_queue.tap do |entries|
-            policies = session.config.policies
-            unless policies.empty?
-              options = usecase?? usecase.options : {}
-              policies.launch(people: people(entries), session: session, options: options)
-            end
-          end
-        end
-
-        def as_update(entry)
-          hash = entry if entry.is_a?(Hash)
-          if only_ids?
-            hash = entry.as_json.slice("id", "external_id", "email")
-          else
-            if entry.is_a?(Ecoportal::API::V1::Person)
-              hash    = entry.as_update
-              if hfields = hash.dig("details", "fields")
-                hash["details"]["fields"] = hfields.map do |fld|
-                  fld.merge!("alt_id" => entry.details.get_field(fld["id"]).alt_id) if entry.details
-                end
-              end
-            end
-
-            fields = hash&.dig('details', 'fields')
-            fields&.map! { |fld| fld&.slice("id", "alt_id", "value") }
-          end
-          hash || {}
-        end
-
-        def only_ids?
-          [:delete, :get].include?(@type)
-        end
-
-        def sets_title
-          "#{@sets.map {|s| s.to_s}.join(", ")}"
-        end
-
-        def launch_feedback(data, max_chars = 800)
-          if !data || !data.is_a?(Enumerable) || data.empty?
-            logger.warn("#{"*" * 20} Nothing for #{signature} so far :)  #{"*" * 20}")
-            return
-          end
-          header = ("*" * 20) + "  #{signature} - Feedback Sample " + ("*" * 20)
-          logger.info(header)
-
-          sample_length = 1
-          sample = data.slice(0, 20).map do |entry|
-            update         = as_update(entry)
-            max_chars     -= update.pretty_inspect.length
-            sample_length += 1 if max_chars > 0
-            update
-          end
-
-          logger.info("#{sample.slice(0, sample_length).pretty_inspect}")
-          logger.info("#{@type.to_s.upcase} length: #{data.length}")
-          logger.info("*" * header.length)
-        end
-
-        def backup_update(data)
-          data_body = data.map { |u| as_update(u) }
-          dir       = config.people.requests_folder
-          file      = File.join(dir, "#{@type}_data.json")
-          file_manager.save_json(data_body, file, :timestamp)
-        end
-
-      end
-
-    end
-  end
-end