Class: CommandTower::ServiceBase

Inherits:

Object

• Object
• CommandTower::ServiceBase

Includes:

ArgumentValidation, ServiceLogging, Interactor

Defined in:

app/services/command_tower/service_base.rb

Direct Known Subclasses

AdminService::Users, Authorize::Validate, InboxService::Blast::Delete, InboxService::Blast::Metadata, InboxService::Blast::NewUserBlaster, InboxService::Blast::Retrieve, InboxService::Blast::Upsert, InboxService::Message::Metadata, InboxService::Message::Modify, InboxService::Message::Retrieve, InboxService::Message::Send, Jwt::AuthenticateUser, Jwt::Decode, Jwt::Encode, Jwt::LoginCreate, Jwt::TimeDelayToken, LoginStrategy::PlainText::Create, LoginStrategy::PlainText::EmailVerification::Generate, LoginStrategy::PlainText::EmailVerification::Required, LoginStrategy::PlainText::EmailVerification::Send, LoginStrategy::PlainText::EmailVerification::Verify, LoginStrategy::PlainText::Login, CommandTower::Secrets::Cleanse, CommandTower::Secrets::Generate, CommandTower::Secrets::Verify, UserAttributes::Modify, UserAttributes::Roles, Username::Available

Defined Under Namespace

Classes: ArgumentValidationError, CompositionValidationError, ConfigurationError, DefaultValueError, KeyValidationError, NameConflictError, NestedOneOfError, OneOfError, ServiceBaseError, ValidationError

Constant Summary

ON_ARGUMENT_VALIDATION =

[
  DEFAULT_VALIDATION = :raise,
  :fail_early,
  :log,
]

Class Method Summary

• .inherited(subclass) ⇒ Object

Instance Method Summary

• #internal_validate(interactor) ⇒ Object
• #service_base_logging(interactor) ⇒ Object
• #validate! ⇒ Object

Methods included from ArgumentValidation

included

Methods included from ServiceLogging

#aletered_message, #class_name, #log, #log_error, #log_info, #log_prefix, #log_warn, #logger, #service_id

Class Method Details

.inherited(subclass) ⇒ Object

# File 'app/services/command_tower/service_base.rb', line 29

def self.inherited(subclass)
  # Add the base logging to the subclass.
  # Since this is done at inheritance time it should always be the first and last hook to run.
  subclass.around(:service_base_logging)
  subclass.around(:internal_validate)
  subclass.after(:sanitize_params)
end

Instance Method Details

#internal_validate(interactor) ⇒ Object

# File 'app/services/command_tower/service_base.rb', line 41

def internal_validate(interactor)
  # call validate that is overridden from child
  begin
    validate! # custom validations defined on the child class
    run_validations! # ArgumentValidation's based on defined settings on child
  rescue StandardError => e
    log_error("Error during validation. #{e.message}")
    raise
  end

  # call interactor
  interactor.call
end

#service_base_logging(interactor) ⇒ Object

# File 'app/services/command_tower/service_base.rb', line 55

def service_base_logging(interactor)
  beginning_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)

  # Pre processing stats
  log_info("Start")

  # Run the job!
  interactor.call

  # Set status for use in ensure block
  status = :complete

# Capture Interactor::Failure for logging purposes, then reraise
rescue ::Interactor::Failure
  # set status for use in ensure block
  status = :failure

  # Re-raise to let the core Interactor handle this
  raise
# Capture exception explicitly for logging purposes, then reraise
rescue ::Exception => e
  # set status for use in ensure block
  status = :error

  # Log error
  log_error("Error #{e.class.name}")

  raise
ensure
  # Always log how long it took along with a status
  finished_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  elapsed = ((finished_time - beginning_time) * 1000).round(2)
  log_info("Finished with [#{status}]...elapsed #{elapsed}ms")
end

#validate! ⇒ Object

# File 'app/services/command_tower/service_base.rb', line 37

def validate!
  # overload from child
end