Module: Railbox::Handler::ClassMethods

Defined in:
lib/railbox/handler/handler.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#outbox_entity ⇒ Object

Returns the value of attribute outbox_entity.



21
22
23
 
# File 'lib/railbox/handler/handler.rb', line 21

def outbox_entity
  @outbox_entity
end

Instance Method Details

#enqueue(method: 'create', body: {}, **opts) ⇒ Object

Queues a request for asynchronous execution

Parameters:

  • method (String) (defaults to: 'create') —

    to be called (default: 'create')

  • body (Hash) (defaults to: {}) —

    main payload for the handler

  • opts (Hash) —

    any additional options (e.g. relative_entity/meta)



28
29
30
 
# File 'lib/railbox/handler/handler.rb', line 28

def enqueue(method: 'create', body: {}, **opts)
  HandlingQueue.enqueue(service: name, method: method, body: body, **opts)
end

#on_failure ⇒ Object

Base failure hook:

  • can be safely called even if not overridden in the service;
  • does nothing by default;
  • when overridden, has access to outbox_entity.


36
37
38
 
# File 'lib/railbox/handler/handler.rb', line 36

def on_failure
  # no-op by default
end