eco-helpers 2.5.2 → 2.5.4

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

@@ -2,11 +2,7 @@ class Eco::API::UseCases::DefaultCases::CreateCase < Eco::API::Common::Loaders::
   name "create"
   type :sync
 
-  attr_reader :options
-
   def main(entries, people, session, options, usecase)
-    @options = options
-    micro    = session.micro
     creation = session.new_job("main", "create",  :create, usecase)
     supers   = session.new_job("post", "supers",  :update, usecase, :core)
 
@@ -23,5 +19,4 @@ class Eco::API::UseCases::DefaultCases::CreateCase < Eco::API::Common::Loaders::
   def append_created
     options.dig(:people, :append_created)
   end
-
 end

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

@@ -2,11 +2,7 @@ class Eco::API::UseCases::DefaultCases::CreateDetailsCase < Eco::API::Common::Lo
   name "create-details"
   type :sync
 
-  attr_reader :options
-
   def main(entries, people, session, options, usecase)
-    @options = options
-    micro    = session.micro
     creation = session.new_job("main", "create",  :create, usecase)
 
     micro.with_each_starter(entries, people, options, log_present: true, append_created: append_created) do |entry, person|
@@ -21,5 +17,4 @@ class Eco::API::UseCases::DefaultCases::CreateDetailsCase < Eco::API::Common::Lo
   def append_created
     options.dig(:people, :append_created)
   end
-
 end

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

@@ -2,11 +2,7 @@ class Eco::API::UseCases::DefaultCases::CreateDetailsWithSupervisorCase < Eco::A
   name "create-details-with-supervisor"
   type :sync
 
-  attr_reader :options
-
   def main(entries, people, session, options, usecase)
-    @options = options
-    micro    = session.micro
     creation = session.new_job("main", "create", :create, usecase)
     supers   = session.new_job("post", "supers", :update, usecase, :core)
 
@@ -22,5 +18,4 @@ class Eco::API::UseCases::DefaultCases::CreateDetailsWithSupervisorCase < Eco::A
   def append_created
     options.dig(:people, :append_created)
   end
-
 end

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

@@ -26,7 +26,7 @@ class Eco::API::UseCases::DefaultCases::CsvToTree
           prev_node ||= node
 
           # If node is nested in prev_node or is a sibling thereof
-          if prev_node.raw_level <= node.raw_level\
+          if prev_node.raw_level <= node.raw_level
             # Make sure parent is among upper level tags
             node.set_high_levels(prev_node)
           else

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

@@ -4,12 +4,8 @@ class Eco::API::UseCases::DefaultCases::CsvToTree < Eco::API::Common::Loaders::U
 
   TIME_FORMAT = '%Y%m%dT%H%M%S'
 
-  attr_reader :session, :options
-
   def main(session, options, usecase)
     options[:end_get] = false
-    @session = session; @options = options
-
     tree_struct = Helper.treeify(Helper.csv_nodes(input_file))
 
     File.open(output_file, "w") do |fd|

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

@@ -3,9 +3,7 @@ class Eco::API::UseCases::DefaultCases::DeleteSyncCase < Eco::API::UseCases::Def
   type :sync
 
   def main(entries, people, session, options, usecase)
-    micro    = session.micro
-    found    = micro.with_each_present(entries, people, options, log_starter: true)
-    delete(found, session, options, usecase)
+    found = micro.with_each_present(entries, people, options, log_starter: true)
+    delete(found)
   end
-
 end

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

@@ -2,13 +2,12 @@ class Eco::API::UseCases::DefaultCases::DeleteTransCase < Eco::API::Common::Load
   name "delete"
   type :transform
 
-  def delete(people, session, options, usecase)
+  def delete(people)
     delete   = session.new_job("main", "delete", :delete, usecase)
     people.each {|person| delete.add(person)}
   end
 
   def main(people, session, options, usecase)
-    delete(people, session, options, usecase)
+    delete(people)
   end
-
 end

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

@@ -9,5 +9,4 @@ class Eco::API::UseCases::DefaultCases::EmailAsIdCase < Eco::API::Common::Loader
       update.add(person)
     end
   end
-
 end

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

@@ -2,11 +2,7 @@ class Eco::API::UseCases::DefaultCases::EntriesToCsv < Eco::API::Common::Loaders
   name "entries-to-csv"
   type :import
 
-  attr_reader :session, :options
-
   def main(entries, session, options, usecase)
-    @options = options
-    @session = session
     entries.export(filename)
   end
 

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

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

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

@@ -3,7 +3,6 @@ class Eco::API::UseCases::DefaultCases::NewEmailCase < Eco::API::Common::Loaders
   type :sync
 
   def main(entries, people, session, options, usecase)
-    micro    = session.micro
     update   = session.new_job("main", "update", :update, usecase, :core)
 
     micro.with_each_present(entries, people, options, log_starter: true) do |entry, person|
@@ -11,5 +10,4 @@ class Eco::API::UseCases::DefaultCases::NewEmailCase < Eco::API::Common::Loaders
       person.email = entry.email
     end
   end
-
 end

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

@@ -3,12 +3,10 @@ class Eco::API::UseCases::DefaultCases::NewIdCase < Eco::API::Common::Loaders::U
   type :sync
 
   def main(entries, people, session, options, usecase)
-    micro    = session.micro
     update   = session.new_job("main", "update", :update, usecase, :core)
     micro.with_each_present(entries, people, options, log_starter: true) do |entry, person|
       update.add(person)
       person.external_id = entry.external_id
     end
   end
-
 end

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

@@ -2,8 +2,6 @@ class Eco::API::UseCases::DefaultCases::OrgDataConvertCase < Eco::API::Common::L
   name "org-data-convert"
   type :import
 
-  attr_reader :session, :options
-
   def org_data_convert(people)
     pp "Going to convert data from '#{source_enviro}' to '#{ASSETS.active_config}'"
     puts "\n"
@@ -22,8 +20,6 @@ class Eco::API::UseCases::DefaultCases::OrgDataConvertCase < Eco::API::Common::L
   end
 
   def main(people, session, options, usecase)
-    @options = options
-    @session = session
     org_data_convert(people)
   end
 
@@ -97,5 +93,4 @@ class Eco::API::UseCases::DefaultCases::OrgDataConvertCase < Eco::API::Common::L
     logger.error(msg)
     exit(1)
   end
-
 end

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

@@ -6,5 +6,4 @@ class Eco::API::UseCases::DefaultCases::RefreshCase < Eco::API::Common::Loaders:
     update   = session.new_job("main", "update", :update, usecase)
     people.each {|person| update.add(person)}
   end
-
 end

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

@@ -3,9 +3,7 @@ class Eco::API::UseCases::DefaultCases::ReinviteSyncCase < Eco::API::UseCases::D
   type :sync
 
   def main(entries, people, session, options, usecase)
-    micro    = session.micro
-    found    = micro.with_each_present(entries, people, options, log_starter: true)
+    found = micro.with_each_present(entries, people, options, log_starter: true)
     reinvite(found.users, session, options, usecase)
   end
-
 end

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

@@ -3,12 +3,12 @@ class Eco::API::UseCases::DefaultCases::ReinviteTransCase < Eco::API::Common::Lo
   type :transform
 
   def main(people, session, options, usecase)
-    reinvite(people.users, session, options, usecase)
+    reinvite(people.users)
   end
 
   private
 
-  def reinvite(users, session, options, usecase)
+  def reinvite(users)
     invite   = session.new_job("main", "invite", :update, usecase, :account)
     users.each do |person|
       if force_invite?

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

@@ -5,7 +5,6 @@ class Eco::API::UseCases::DefaultCases::RemoveAccountSyncCase < Eco::API::UseCas
   def main(entries, people, session, options, usecase)
     micro    = session.micro
     found    = micro.with_each_present(entries, people, options, log_starter: true)
-    remove_account(found.users, session, options, usecase)
+    remove_account(found.users)
   end
-
 end

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

@@ -2,7 +2,7 @@ class Eco::API::UseCases::DefaultCases::RemoveAccountTransCase < Eco::API::Commo
   name "remove-account"
   type :transform
 
-  def remove_account(users, session, options, usecase)
+  def remove_account(users)
     update   = session.new_job("main", "update", :update, usecase, :account)
     users.each do |user|
       user.account = nil
@@ -11,7 +11,6 @@ class Eco::API::UseCases::DefaultCases::RemoveAccountTransCase < Eco::API::Commo
   end
 
   def main(people, session, options, usecase)
-    remove_account(people.users, session, options, usecase)
+    remove_account(people.users)
   end
-
 end

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

@@ -2,12 +2,8 @@ class Eco::API::UseCases::DefaultCases::ResetLandingPageCase < Eco::API::Common:
   name "reset-landing-page"
   type :transform
 
-  attr_reader :session, :options
-
   def main(people, session, options, usecase)
-    @session = session; @options = options
-    update   = session.new_job("main", "update", :update, usecase, :core)
-
+    update = session.new_job("main", "update", :update, usecase, :core)
     people.users.each do |user|
       user.account.landing_page_id = page_id
       update.add(user)
@@ -19,6 +15,4 @@ class Eco::API::UseCases::DefaultCases::ResetLandingPageCase < Eco::API::Common:
   def page_id
     options[:page_id]
   end
-
-
 end

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

@@ -2,12 +2,7 @@ class Eco::API::UseCases::DefaultCases::RestoreDBCase < Eco::API::Common::Loader
   name "restore-db"
   type :sync
 
-  attr_reader :session, :options
-
   def main(entries, people, session, options, usecase)
-    @session = session; @options = options
-
-    micro    = session.micro
     require_people_as_entries!(entries)
 
     restart  = session.new_job("main", "restart", :create, usecase) if options.dig(:include, :create)
@@ -95,9 +90,4 @@ class Eco::API::UseCases::DefaultCases::RestoreDBCase < Eco::API::Common::Loader
       end
     end
   end
-
-  def logger
-    session.logger
-  end
-
 end

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

@@ -7,7 +7,6 @@ class Eco::API::UseCases::DefaultCases::SetDefaultTagCase < Eco::API::Common::Lo
   # => take the common node between them (i.e. you have Hamilton and Auckland -> take New Zealand)
   # => if there's no common node between them, take the `first` (unless they are at top level of the tree)
   def main(people, session, options, usecase)
-    micro    = session.micro
     tagtree_present!(session)
     users    = users_present!(people, session)
     update   = session.new_job("main", "update", :update, usecase, :account)

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

@@ -3,7 +3,6 @@ class Eco::API::UseCases::DefaultCases::SetSupervisorCase < Eco::API::Common::Lo
   type :sync
 
   def main(entries, people, session, options, usecase)
-    micro    = session.micro
     update   = session.new_job("main", "update", :update, usecase)
 
     micro.with_each_present(entries, people, options, log_starter: true) do |entry, person|

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

@@ -2,11 +2,11 @@ class Eco::API::UseCases::DefaultCases::SupersCyclicIdentify < Eco::API::Common:
   name "identify-cyclic-supers"
   type :export
 
-  attr_reader :session, :people, :options
+  attr_reader :people
 
   def main(people, session, options, usecase)
     options[:end_get] = false
-    @session = session; @options = options; @people = people
+    @people = people
 
     save!(cyclic_sets)
   end
@@ -68,5 +68,4 @@ class Eco::API::UseCases::DefaultCases::SupersCyclicIdentify < Eco::API::Common:
       str << set_to_str(set, lev: lev + 1, format: format) unless !set || set.empty?
     end
   end
-
 end

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

@@ -2,11 +2,11 @@ class Eco::API::UseCases::DefaultCases::SupersHierarchy < Eco::API::Common::Load
   name "supers-hierarchy"
   type :export
 
-  attr_reader :session, :people, :options
+  attr_reader :people
 
   def main(people, session, options, usecase)
     options[:end_get] = false
-    @session = session; @options = options; @people = people
+    @people = people
 
     save!(hierarchy)
   end
@@ -55,5 +55,4 @@ class Eco::API::UseCases::DefaultCases::SupersHierarchy < Eco::API::Common::Load
       end
     end
   end
-
 end

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

@@ -3,10 +3,9 @@ class Eco::API::UseCases::DefaultCases::SwitchSupervisorCase < Eco::API::Common:
   type :transform
 
   def main(people, session, options, usecase)
-    micro    = session.micro
     supers   = session.new_job("main", "supers", :update, usecase, :core)
 
-    old_sup, new_sup = get_supers(people, session, options).tap do |supers|
+    old_sup, new_sup = get_supers(people).tap do |supers|
       inform(*supers, session.logger)
     end
 
@@ -24,7 +23,7 @@ class Eco::API::UseCases::DefaultCases::SwitchSupervisorCase < Eco::API::Common:
 
   private
 
-  def get_supers(people, session, options)
+  def get_supers(people)
     micro            = session.micro
     old_id,  new_id  = get_super_ids(options)
     old_sup, new_sup = [nil, nil]
@@ -66,5 +65,4 @@ class Eco::API::UseCases::DefaultCases::SwitchSupervisorCase < Eco::API::Common:
     msg += "to '#{new_sup&.name}' (#{new_sup&.external_id})"
     logger.info(msg)
   end
-
 end

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

@@ -2,12 +2,10 @@ class Eco::API::UseCases::DefaultCases::TagTree < Eco::API::Common::Loaders::Use
   name "tagtree"
   type :other
 
-  attr_reader :session, :options
   def main(session, options, usecase)
     puts "Use case still in development"
     exit
     options[:end_get] = false
-    @session = session; @options = options
     operations.keys.each do |key|
       process(key)
     end

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

@@ -2,14 +2,14 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
   name "to-csv"
   type :export
 
-  attr_reader :session, :options, :people
+  attr_reader :people
 
   def main(people, session, options, usecase)
     options[:end_get] = false
-    @session = session; @options = options; @people = people
+    @people = people
 
     unless people && !people.empty?
-      session.logger.warn("No source people to create the file... aborting!")
+      logger.warn("No source people to create the file... aborting!")
       return false
     end
 
@@ -27,7 +27,7 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
   private
 
   def create_file!(filename = file, data = people)
-    session.logger.info("going to create file: #{filename}")
+    logger.info("going to create file: #{filename}")
 
     CSV.open(filename, "w") do |csv|
       csv << spot_header(data.first)
@@ -128,5 +128,4 @@ class Eco::API::UseCases::DefaultCases::ToCsvCase < Eco::API::Common::Loaders::U
       "landing_page_id"    => "Landing Page ID"
     }
   end
-
 end

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

@@ -116,5 +116,4 @@ class Eco::API::UseCases::DefaultCases::ToCsvDetailedCase < Eco::API::UseCases::
       "custom_person_abilities"   => "(min) on Users' Abilities"
     })
   end
-
 end

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

@@ -37,7 +37,6 @@ class Eco::API::UseCases::DefaultCases::TransferAccountCase < Eco::API::Common::
   #   * `:api_policies` (Boolean) [false] if the `api policies` should be skipped (**command option**: `-skip-api-policies`)
   # @return [Void]
   def main(entries, people, session, options, usecase)
-    micro    = session.micro
     move     = session.new_job("main", "move email accounts", :update, usecase, :account)
     free     = session.new_job("main", "free up accounts",    :update, usecase, :account)
     switch   = session.new_job("main", "switch email",        :update, usecase, :core)
@@ -266,5 +265,4 @@ class Eco::API::UseCases::DefaultCases::TransferAccountCase < Eco::API::Common::
   def report_repeated(str, logger, msg = "The following entries are repeated")
     logger.error("#{msg}\n#{str}")
   end
-
 end

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

@@ -3,7 +3,6 @@ class Eco::API::UseCases::DefaultCases::UpdateCase < Eco::API::Common::Loaders::
   type :sync
 
   def main(entries, people, session, options, usecase)
-    micro    = session.micro
     update   = session.new_job("main", "update", :update, usecase)
     supers   = session.new_job("post", "supers", :update, usecase, :core)
 
@@ -14,5 +13,4 @@ class Eco::API::UseCases::DefaultCases::UpdateCase < Eco::API::Common::Loaders::
       micro.set_account(entry, person, options)
     end
   end
-
 end

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

@@ -3,7 +3,6 @@ class Eco::API::UseCases::DefaultCases::UpdateDetailsCase < Eco::API::Common::Lo
   type :sync
 
   def main(entries, people, session, options, usecase)
-    micro    = session.micro
     update   = session.new_job("main", "update", :update, usecase)
     supers   = session.new_job("post", "supers", :update, usecase, :core)
 
@@ -13,5 +12,4 @@ class Eco::API::UseCases::DefaultCases::UpdateDetailsCase < Eco::API::Common::Lo
       entry.set_details(person) unless options.dig(:exclude, :details)
     end
   end
-
 end

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

@@ -2,10 +2,7 @@ class Eco::API::UseCases::DefaultCases::UpsertCase < Eco::API::Common::Loaders::
   name "upsert"
   type :sync
 
-  attr_reader :options
-
   def main(entries, people, session, options, usecase)
-    @options = options
     micro    = session.micro
     creation = session.new_job("main", "create", :create, usecase)
     update   = session.new_job("main", "update", :update, usecase)
@@ -24,5 +21,4 @@ class Eco::API::UseCases::DefaultCases::UpsertCase < Eco::API::Common::Loaders::
   def append_created
     options.dig(:people, :append_created)
   end
-
 end

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

@@ -1,32 +1,20 @@
 class Eco::API::UseCases::GraphQL::Base < Eco::API::Common::Loaders::UseCase
+  class NotImplementedMethod < StandardError
+  end
+  
   name "graphql-base"
   type :other
 
-  attr_reader :session, :options, :usecase
+  include Eco::API::UseCases::GraphQL::Helpers::Base
 
   def main(session, options, usecase)
+    options.deep_merge!(workflow: {no_email: true}) # prevent the default mailer to quick in
     options[:end_get] = false
-    @session = session; @options = options; @usecase = usecase
     process
   end
 
   # Write here your script
   def process
-    raise "You need to inherit from this class ('#{self.class}') and call super with a block"
-  end
-
-  private
-
-  def graphql
-    @graphql ||= session.api(version: :graphql)
-  end
-
-  def simulate?
-    options.dig(:simulate)
-  end
-
-  def exit_error(msg)
-    logger.error(msg)
-    exit(1)
+    raise NotImplementedMethod, "You need to inherit from this class ('#{self.class}') and call super with a block"
   end
 end

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

@@ -0,0 +1,15 @@
+module Eco::API::UseCases::GraphQL::Helpers::Base
+  # Basic stuff you would need in any use case
+  module CaseEnv
+    include Eco::Language::AuxiliarLogger
+    attr_reader :session, :options
+
+    def config
+      session.config
+    end
+
+    def simulate?
+      options.dig(:simulate)
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Eco::API::UseCases::GraphQL::Helpers
+  module Base
+    require_relative 'base/case_env'
+    include Eco::API::UseCases::GraphQL::Helpers::Base::CaseEnv
+
+    def graphql
+      @graphql ||= session.api(version: :graphql)
+    end
+
+    # Keep a copy of the requests/responses for future reference
+    def backup(data, type:)
+      dry_run   = simulate? ? "_dry_run" : ""
+      dir       = config.people.requests_folder
+      file      = File.join(dir, "#{type}#{dry_run}.json")
+      session.file_manager.save_json(data, file, :timestamp)
+    end
+
+    def exit_error(msg)
+      log(:error) { msg }
+      exit(1)
+    end
+  end
+end