Class: Eco::API::Common::Loaders::UseCase

Inherits:

CaseBase

• Object
• Base
• CaseBase
• Eco::API::Common::Loaders::UseCase

Defined in:

lib/eco/api/common/loaders/use_case.rb

Direct Known Subclasses

Eco::API::Custom::UseCase, UseCases::DefaultCases::AbstractPolicyGroupAbilities, UseCases::DefaultCases::AnalysePeople, UseCases::DefaultCases::AppendUsergroupsCase, UseCases::DefaultCases::ChangeEMailCase, UseCases::DefaultCases::CleanUnknownTags, UseCases::DefaultCases::ClearAbilitiesTransCase, UseCases::DefaultCases::CodesToTagsCase, UseCases::DefaultCases::CreateCase, UseCases::DefaultCases::CreateDetailsCase, UseCases::DefaultCases::CreateDetailsWithSupervisorCase, UseCases::DefaultCases::CsvToTree, UseCases::DefaultCases::DeleteTransCase, UseCases::DefaultCases::EmailAsIdCase, UseCases::DefaultCases::EntriesToCsv, UseCases::DefaultCases::HrisCase, UseCases::DefaultCases::NewEmailCase, UseCases::DefaultCases::NewIdCase, UseCases::DefaultCases::OrgDataConvertCase, UseCases::DefaultCases::RefreshCase, UseCases::DefaultCases::ReinviteTransCase, UseCases::DefaultCases::RemoveAccountTransCase, UseCases::DefaultCases::ResetLandingPageCase, UseCases::DefaultCases::RestoreDBCase, UseCases::DefaultCases::Samples::Sftp, UseCases::DefaultCases::SetDefaultTagCase, UseCases::DefaultCases::SetSupervisorCase, UseCases::DefaultCases::SupersCyclicIdentify, UseCases::DefaultCases::SupersHierarchy, UseCases::DefaultCases::SwitchSupervisorCase, UseCases::DefaultCases::TagPaths, UseCases::DefaultCases::TagTree, UseCases::DefaultCases::ToCsvCase, UseCases::DefaultCases::TransferAccountCase, UseCases::DefaultCases::UpdateCase, UseCases::DefaultCases::UpdateDetailsCase, UseCases::DefaultCases::UpsertCase, UseCases::GraphQL::Base, UseCases::OozeSamples::OozeBaseCase, UseCases::OozeSamples::RegisterExportCase

Class Method Summary

• .type(value = nil) ⇒ Symbol

  The type of usecase (i.e. :sync, :transform, :import, :other).

Instance Method Summary

• #initialize(usecases) ⇒ UseCase constructor

  A new instance of UseCase.

• #main(entries, people, session, options, usecase) ⇒ Object

  The parameters of this method will depend on the type of usecase.

• #type ⇒ Object

Methods inherited from CaseBase

#name, name_only_once!

Methods inherited from Base

<=>, created_at, #name, set_created_at!

Methods included from ClassHelpers

#class_resolver, #descendants, #descendants?, #inheritable_attrs, #inheritable_class_vars, #inherited, #instance_variable_name, #new_class, #resolve_class, #to_constant

Constructor Details

#initialize(usecases) ⇒ UseCase

Returns a new instance of UseCase.

# File 'lib/eco/api/common/loaders/use_case.rb', line 19

def initialize(usecases)
  raise "Expected Eco::API::UseCases. Given #{usecases.class}" unless usecases.is_a?(Eco::API::UseCases)
  usecases.define(self.name, type: self.type, &self.method(:main))
end

Class Method Details

.type(value = nil) ⇒ Symbol

Returns the type of usecase (i.e. :sync, :transform, :import, :other).

Returns:

• (Symbol) —

  the type of usecase (i.e. :sync, :transform, :import, :other)

# File 'lib/eco/api/common/loaders/use_case.rb', line 9

def type(value = nil)
  unless value
    return @type || raise("You should specify a type of case [:sync, :transform, :import, :other] for #{self}")
  end
  @type = value
end

Instance Method Details

#main(entries, people, session, options, usecase) ⇒ Object

The parameters of this method will depend on the type of usecase.

Parameters:

• entries (Eco::API::Common::People::Entries) —

  the input entries with the data.

• people (Eco::API::Organization::People) —

  the people in the queue of the current job

• session (Eco::API::Session) —

  the current session where the usecase kicks in.

• options (Hash) —

  the options that modify the case behaviour or bring some dependencies.

• usecase (Eco::API::Policies::Policy) —

  the usecase instance object.

# File 'lib/eco/api/common/loaders/use_case.rb', line 30

def main(entries, people, session, options, usecase)
  raise "You should implement this method"
end

#type ⇒ Object

# File 'lib/eco/api/common/loaders/use_case.rb', line 34

def type
  self.class.type
end