eco-helpers 0.9.2 → 0.9.3

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

@@ -0,0 +1,97 @@
+module Eco
+  module API
+    class UseCases
+      class BaseIO < BaseCase
+        @types  = [:import, :filter, :transform, :sync, :export]
+
+        class << self
+          def input_required?(type)
+            !valid_type?(type) || [:import, :sync].include?(type)
+          end
+
+          def people_required?(type)
+            !valid_type?(type) || [:filter, :transform, :sync, :export].include?(type)
+          end
+
+        end
+
+        attr_reader   :input, :people, :session, :options
+        attr_reader   :type
+        attr_accessor :output
+
+        # @param type [Symbol] a valid type (among `self.class.types`)
+        # @param input [Eco::API::Common::People::Entries, Eco::API::Organization::People] the input data of reference.
+        # @param people [Eco::API::Organization::People] people object.
+        # @param session [Eco::API:Session]
+        # @param options [Hash] hash with symbol keys (i.e. behaviour modifiers, cli trackers, filters, etc.)
+        def initialize(type: nil, input: nil, people: nil, session:, options: {})
+          @output      = nil
+          self.type    = type if type
+
+          if self.type
+            validate_args(input: input, people: people, session: session, options: options)
+          end
+
+          @input       = input
+          @people      = people
+          @session     = session
+          @options     = options
+        end
+
+        # @param value [Symbol] a valid type (among `self.class.types`)
+        def type=(value)
+          self.class.validate_type(value)
+          @type = value
+        end
+
+        # Helper to obtain an `BaseIO` objcect from any child class.
+        # @return [Eco::API::UseCases::BaseIO]
+        def base
+          kargs = params(keyed: true).merge(type: self.type).slice(:type, :input, :people, :session, :options)
+          Eco::API::UseCases::BaseIO.new(**kargs)
+        end
+
+        # @see Eco::API::UseCases::BaseIO#initialize
+        # @return [Eco::API::UseCases::BaseIO]
+        def new(type: self.type, input: self.input, people: self.people, session: self.session, options: self.options)
+          self.class.new(type: type, input: input, people: people, session: session, options: options)
+        end
+
+        # Helper to build a `Hash` of symbol keys or `Array` with params to do callbacks.
+        def params(keyed: false)
+          kargs = {}
+          kargs.merge!(input:    input)  if input_required?
+          kargs.merge!(people:  people)  if people_required?
+          kargs.merge!(session: session, options: options)
+          keyed ? kargs : kargs.values
+        end
+
+        private
+
+        def validate_args(input:, people:, session:, options:)
+          case
+          when !session.is_a?(Eco::API::Session)
+            raise "A UseCase needs a Session object. Given: #{session}"
+          when input_required? && !input
+            raise "UseCase of type '#{type}' requires a valid input. None given"
+          when people_required? && !people.is_a?(Eco::API::Organization::People)
+            raise "UseCase of type '#{type}' requires a People object. Given: #{people}"
+          when !options || (options && !options.is_a?(Hash))
+            raise "To inject dependencies via ':options' it should be a Hash object. Given: #{options}"
+          end
+          true
+        end
+
+        def input_required?
+          self.class.input_required?(type)
+        end
+
+        def people_required?
+          self.class.people_required?(type)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Eco
+  module API
+    class UseCases
+      class DefaultCase
+
+        def initialize(cases, **options)
+          raise "Expected a Eco::API::UseCases object. Given #{cases.class}" if !cases.is_a?(Eco::API::UseCases)
+          @cases   = cases
+          @options = options
+        end
+
+        def process
+          raise "You should reimplement this method"
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module Eco
   module API
-    module UseCases
-      class DefaultCases < UseGroup
+    class UseCases
+      class DefaultCases < Eco::API::UseCases
 
         def initialize(*args)
           super(*args)

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class ChangeEMailCase < BaseCase
+        class ChangeEMailCase < DefaultCase
 
           def process
             @cases.define("change-email", type: :sync) do |entries, people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class CreateCase < UseCases::BaseCase
+        class CreateCase < DefaultCase
 
           def process
             @cases.define("create", type: :sync) do |entries, people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class CreateDetailsCase < UseCases::BaseCase
+        class CreateDetailsCase < DefaultCase
 
           def process
             @cases.define("create-details", type: :sync) do |entries, people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class CreateDetailsWithSupervisorCase < UseCases::BaseCase
+        class CreateDetailsWithSupervisorCase < DefaultCase
 
           def process
             # good candidate to do @cases.case("create-details").use.chain(@cases.case("set-supervisor").use)

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class DeleteCase < BaseCase
+        class DeleteCase < DefaultCase
 
           def process
             @cases.define("delete", type: :transform) do |people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class EmailAsIdCase < BaseCase
+        class EmailAsIdCase < DefaultCase
 
           def process
             @cases.define("email-as-id", type: :transform) do |people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class HrisCase < BaseCase
+        class HrisCase < DefaultCase
 
           def process
             @cases.define("hris", type: :sync) do |entries, people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class NewEmailCase < BaseCase
+        class NewEmailCase < DefaultCase
 
           def process
             @cases.define("new-email", type: :sync) do |entries, people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class NewIdCase < BaseCase
+        class NewIdCase < DefaultCase
 
           def process
             @cases.define("new-id", type: :sync) do |entries, people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class RecoverDBCase < BaseCase
+        class RecoverDBCase < DefaultCase
 
           def process
             @cases.define("recover-db", type: :sync) do |entries, people, session, options, usecase|
@@ -10,22 +10,25 @@ module Eco
                 raise "Your input should be an 'Eco::API::Organization::People' object. Got: #{entries.class}"
               end
 
-              creation = session.job_group("main").new("create", usecase: usecase, type: :create, sets: [:core, :details, :account])
-              update   = session.job_group("main").new("update", usecase: usecase, type: :update, sets: [:core, :details, :account])
-              remove   = session.job_group("main").new("remove", usecase: usecase, type: :delete, sets: [:core, :details, :account])
+              if options.dig(:include, :create)
+                creation = session.job_group("main").new("create", usecase: usecase, type: :create, sets: [:core, :details, :account])
+              end
 
-              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
-              pgs = session.policy_groups
+              update   = session.job_group("main").new("update", usecase: usecase, type: :update, sets: [:core, :details, :account])
 
               if options.dig(:include, :delete)
+                remove   = session.job_group("main").new("remove", usecase: usecase, type: :delete, sets: [:core, :details, :account])
                 people.exclude(entries).map {|person| remove.add(person)}
               end
 
+              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
+              pgs = session.policy_groups
+
               entries.each.with_index do |entry, i|
                 create = ! (person = people.find(entry, strict: strict_search))
 
                 if create && !options.dig(:include, :create)
-                  session.logger.error("Entry(#{i}) - this person does not exist: #{entry.email}")
+                  session.logger.error("Entry(#{i}) - this person does not exist: #{entry.name} (#{entry.email})")
                 else
                   person = session.new_person if create
 

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class RefreshPresets < BaseCase
+        class RefreshPresets < DefaultCase
 
           def process
             @cases.define("refresh-presets", type: :transform) do |people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class ReinviteCase < BaseCase
+        class ReinviteCase < DefaultCase
 
           def process
             @cases.define("reinvite", type: :transform) do |people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class RemoveAccountCase < BaseCase
+        class RemoveAccountCase < DefaultCase
 
           def process
 

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class ResetLandingPageCase < UseCases::BaseCase
+        class ResetLandingPageCase < DefaultCase
 
           def process
             @cases.define("reset-landing-page", type: :transform) do |people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class SetDefaultTagCase < BaseCase
+        class SetDefaultTagCase < DefaultCase
           # take the deepest tag (the one that is further down in the tree)
           # different options (several nodes at the same depth):
           # => take the common node between them (i.e. you have Hamilton and Auckland -> take New Zealand)

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class SetSupervisorCase < BaseCase
+        class SetSupervisorCase < DefaultCase
 
           def process
             @cases.define("set-supervisor", type: :sync) do |entries, people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class SwitchSupervisorCase < UseCases::BaseCase
+        class SwitchSupervisorCase < DefaultCase
 
           def process
             @cases.define("switch-supervisor", type: :transform) do |people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class ToCsvCase < BaseCase
+        class ToCsvCase < DefaultCase
 
           def process
             @cases.define("to-csv", type: :export) do |people, session, options, usecase|
@@ -11,7 +11,7 @@ module Eco
                 next false
               end
 
-              unless file = options[:file]
+              unless file = options[:file] || options.dig(:export, :file, :name)
                 session.logger.error("Destination file not specified")
                 next false
               end
@@ -22,7 +22,7 @@ module Eco
                 entry  = session.new_entry(people.first, dependencies: deps)
                 header = entry.to_hash.keys
 
-                if options.dig(:nice_header)
+                if options.dig(:nice_header) || options.dig(:export, :options, :nice_header)
                   name_maps = session.schema.fields_by_alt_id.transform_values do |fld|
                     fld.name
                   end.merge({

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class ToCsvDetailedCase < BaseCase
+        class ToCsvDetailedCase < DefaultCase
 
           def process
             @cases.define("to-csv-detailed", type: :export) do |people, session, options, usecase|
@@ -11,7 +11,7 @@ module Eco
                 next false
               end
 
-              unless file = options[:file]
+              unless file = options[:file] || options.dig(:export, :file, :name)
                 session.logger.error("Destination file not specified")
                 next false
               end

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class UpdateCase < BaseCase
+        class UpdateCase < DefaultCase
 
           def process
             #opts = CLI::Options.new do |p|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class UpdateDetailsCase < BaseCase
+        class UpdateDetailsCase < DefaultCase
 
           def process
             @cases.define("update-details", type: :sync) do |entries, people, session, options, usecase|

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

@@ -1,8 +1,8 @@
 module Eco
   module API
-    module UseCases
+    class UseCases
       class DefaultCases
-        class UpsertCase < BaseCase
+        class UpsertCase < DefaultCase
 
           def process
             @cases.define("upsert", type: :sync) do |entries, people, session, options, usecase|