Class: Ears::Consumer Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/ears/consumer.rb

Overview

This class is abstract.

Subclass and override #work to implement.

The abstract base class for consumers processing messages from queues.

Defined Under Namespace

Classes: InvalidReturnError

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.middlewares ⇒ Array<Ears::Middleware>

List of registered middlewares. Register new middlewares with use.

Returns:



18
19
20
 
# File 'lib/ears/consumer.rb', line 18

def self.middlewares
  @middlewares ||= []
end

.use(middleware, opts = {}) ⇒ Object

Registers a new middleware by instantiating +middleware+ and passing it +opts+.

Parameters:

  • middleware (Class<Ears::Middleware>) —

    The middleware class to instantiate and register.

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

    The options for instantiating the middleware.



26
27
28
 
# File 'lib/ears/consumer.rb', line 26

def self.use(middleware, opts = {})
  middlewares << middleware.new(opts)
end

Instance Method Details

#process_delivery(delivery_info, metadata, payload) ⇒ Object

Wraps #work to add middlewares. This is being called by Ears when a message is received for the consumer.

Parameters:

  • delivery_info (Bunny::DeliveryInfo) —

    The delivery info of the received message.

  • metadata (Bunny::MessageProperties) —

    The metadata of the received message.

  • payload (String) —

    The payload of the received message.

Raises:



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/ears/consumer.rb', line 48

def process_delivery(delivery_info, metadata, payload)
  self
    .class
    .middlewares
    .reverse
    .reduce(work_proc) do |next_middleware, middleware|
      nest_middleware(middleware, next_middleware)
    end
    .call(delivery_info, metadata, payload)
end

#work(delivery_info, metadata, payload) ⇒ :ack, ...

The method that is called when a message from the queue is received. Keep in mind that the parameters received can be altered by middlewares!

Parameters:

  • delivery_info (Bunny::DeliveryInfo) —

    The delivery info of the message.

  • metadata (Bunny::MessageProperties) —

    The metadata of the message.

  • payload (String) —

    The payload of the message.

Returns:

  • (:ack, :reject, :requeue) —

    A symbol denoting what should be done with the message.

Raises:

  • (NotImplementedError) 


38
39
40
 
# File 'lib/ears/consumer.rb', line 38

def work(delivery_info, metadata, payload)
  raise NotImplementedError
end