Class: Eco::API::Common::Loaders::Policy

Inherits:

CaseBase

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

Defined in:

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

Direct Known Subclasses

Eco::API::Custom::Policy, Policies::DefaultPolicies::UserAccess

Instance Attribute Summary

Attributes included from Language::AuxiliarLogger

#logger

Instance Method Summary

• #initialize(policies) ⇒ Policy constructor

  A new instance of Policy.

• #main(people, session, options, policy, job) ⇒ Object

Methods inherited from CaseBase

#name, name_only_once!

Methods inherited from Base

<=>, created_at, 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

Methods included from Language::AuxiliarLogger

#log

Constructor Details

#initialize(policies) ⇒ Policy

Returns a new instance of Policy.

# File 'lib/eco/api/common/loaders/policy.rb', line 6

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

Instance Method Details

#main(people, session, options, policy, job) ⇒ Object

Parameters:

• 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.

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

  the policy instance object.

• job (Eco::API::Session::Batch::Job) —

  the Batch::Job that these people belong to the queue thereof.

# File 'lib/eco/api/common/loaders/policy.rb', line 16

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