Class: BunnyMock::Channel

Inherits:
Object
  • Object
show all
Defined in:
lib/bunny_mock/channel.rb

Instance Attribute Summary collapse

Exchange API collapse

Queue API collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection = nil, id = nil) ⇒ Channel

Create a new BunnyMock::Channel instance

Parameters:

  • connection (BunnyMock::Session) (defaults to: nil) —

    Mocked session instance

  • id (Integer) (defaults to: nil) —

    Channel identifier



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/bunny_mock/channel.rb', line 28

def initialize(connection = nil, id = nil)
  # store channel id
  @id = id

  # store connection information
  @connection = connection

  # initialize exchange and queue storage
  @exchanges = {}
  @queues    = {}
  @acknowledged_state = { pending: {}, acked: {}, nacked: {}, rejected: {} }

  # set status to opening
  @status = :opening
end

Instance Attribute Details

#acknowledged_state ⇒ Hash (readonly)

Returns with details of pending, acked and nacked messaged.

Returns:

  • (Hash) —

    with details of pending, acked and nacked messaged



18
19
20
 
# File 'lib/bunny_mock/channel.rb', line 18

def acknowledged_state
  @acknowledged_state
end

#connection ⇒ BunnyMock::Session (readonly)

Returns Session this channel belongs to.

Returns:



12
13
14
 
# File 'lib/bunny_mock/channel.rb', line 12

def connection
  @connection
end

#id ⇒ Integer (readonly)

Returns Channel identifier.

Returns:

  • (Integer) —

    Channel identifier



9
10
11
 
# File 'lib/bunny_mock/channel.rb', line 9

def id
  @id
end

#status ⇒ Symbol (readonly)

Returns Current channel state.

Returns:

  • (Symbol) —

    Current channel state



15
16
17
 
# File 'lib/bunny_mock/channel.rb', line 15

def status
  @status
end

Instance Method Details

#ack(delivery_tag, multiple = false) ⇒ Object Also known as: acknowledge

Acknowledge message.

Parameters:

  • delivery_tag (Integer) —

    Delivery tag to acknowledge

  • multiple (Boolean) (defaults to: false) —

    (false) Should all unacknowledged messages up to this be acknowleded as well?

Returns:

  • nil



279
280
281
282
283
284
285
286
287
288
 
# File 'lib/bunny_mock/channel.rb', line 279

def ack(delivery_tag, multiple = false)
  if multiple
    @acknowledged_state[:pending].keys.each do |key|
      ack(key, false) if key <= delivery_tag
    end
  elsif @acknowledged_state[:pending].key?(delivery_tag)
    update_acknowledgement_state(delivery_tag, :acked)
  end
  nil
end

#basic_publish(payload, xchg, routing_key, opts = {}) ⇒ BunnyMock::Channel

Returns Self.

Returns:



201
202
203
204
205
206
207
 
# File 'lib/bunny_mock/channel.rb', line 201

def basic_publish(payload, xchg, routing_key, opts = {})
  xchg = xchg_find_or_create(xchg) unless xchg.respond_to? :name

  xchg.publish payload, opts.merge(routing_key: routing_key)

  self
end

#close ⇒ BunnyMock::Channel

Sets status to closed

Returns:



74
75
76
77
78
 
# File 'lib/bunny_mock/channel.rb', line 74

def close
  @status = :closed

  self
end

#closed? ⇒ Boolean

Returns true if status is closed, false otherwise.

Returns:

  • (Boolean) —

    true if status is closed, false otherwise



52
53
54
 
# File 'lib/bunny_mock/channel.rb', line 52

def closed?
  @status == :closed
end

#confirm_select(callback = nil) ⇒ Object

Does nothing atm.

Returns:

  • nil



246
247
248
 
# File 'lib/bunny_mock/channel.rb', line 246

def confirm_select(callback = nil)
  # noop
end

#default_exchange ⇒ BunnyMock::Exchange

Mocks RabbitMQ default exchange

Returns:



188
189
190
 
# File 'lib/bunny_mock/channel.rb', line 188

def default_exchange
  direct '', no_declare: true
end

#direct(name, opts = {}) ⇒ BunnyMock::Exchange

Mocks a direct exchange

Parameters:

  • name (String) —

    Exchange name

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

    Exchange parameters

Options Hash (opts):

  • :durable (Boolean)
  • :auto_delete (Boolean)
  • :arguments (Hash)

Returns:



144
145
146
 
# File 'lib/bunny_mock/channel.rb', line 144

def direct(name, opts = {})
  exchange name, opts.merge(type: :direct)
end

#exchange(name, opts = {}) ⇒ BunnyMock::Exchange

Mocks an exchange

Parameters:

  • name (String) —

    Exchange name

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

    Exchange parameters

Options Hash (opts):

  • :type (Symbol, String) —

    Type of exchange

  • :durable (Boolean)
  • :auto_delete (Boolean)
  • :arguments (Hash)

Returns:



102
103
104
 
# File 'lib/bunny_mock/channel.rb', line 102

def exchange(name, opts = {})
  @connection.register_exchange xchg_find_or_create(name, opts)
end

#fanout(name, opts = {}) ⇒ BunnyMock::Exchange

Mocks a fanout exchange

Parameters:

  • name (String) —

    Exchange name

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

    Exchange parameters

Options Hash (opts):

  • :durable (Boolean)
  • :auto_delete (Boolean)
  • :arguments (Hash)

Returns:



127
128
129
 
# File 'lib/bunny_mock/channel.rb', line 127

def fanout(name, opts = {})
  exchange name, opts.merge(type: :fanout)
end

#generate_consumer_tag(name = 'bunny') ⇒ String

Unique string supposed to be used as a consumer tag.

Returns:

  • (String) —

    Unique string.



110
111
112
 
# File 'lib/bunny_mock/channel.rb', line 110

def generate_consumer_tag(name = 'bunny')
  "#{name}-#{Time.now.to_i * 1000}-#{Kernel.rand(999_999_999_999)}"
end

#header(name, opts = {}) ⇒ BunnyMock::Exchange

Mocks a headers exchange

Parameters:

  • name (String) —

    Exchange name

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

    Exchange parameters

Options Hash (opts):

  • :durable (Boolean)
  • :auto_delete (Boolean)
  • :arguments (Hash)

Returns:



178
179
180
 
# File 'lib/bunny_mock/channel.rb', line 178

def header(name, opts = {})
  exchange name, opts.merge(type: :header)
end

#nack(delivery_tag, multiple = false, requeue = false) ⇒ Object

Unacknowledge message.

Parameters:

  • delivery_tag (Integer) —

    Delivery tag to acknowledge

  • multiple (Boolean) (defaults to: false) —

    (false) Should all unacknowledged messages up to this be rejected as well?

  • requeue (Boolean) (defaults to: false) —

    (false) Should this message be requeued instead of dropping it?

Returns:

  • nil



301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/bunny_mock/channel.rb', line 301

def nack(delivery_tag, multiple = false, requeue = false)
  if multiple
    @acknowledged_state[:pending].keys.each do |key|
      nack(key, false, requeue) if key <= delivery_tag
    end
  elsif @acknowledged_state[:pending].key?(delivery_tag)
    delivery, header, body = update_acknowledgement_state(delivery_tag, :nacked)
    delivery.queue.publish(body, header.to_hash) if requeue
  end
  nil
end

#open ⇒ BunnyMock::Channel

Sets status to open

Returns:



62
63
64
65
66
 
# File 'lib/bunny_mock/channel.rb', line 62

def open
  @status = :open

  self
end

#open? ⇒ Boolean

Returns true if status is open, false otherwise.

Returns:

  • (Boolean) —

    true if status is open, false otherwise



46
47
48
 
# File 'lib/bunny_mock/channel.rb', line 46

def open?
  @status == :open
end

#prefetch ⇒ Object

Does nothing atm.

Returns:

  • nil



256
257
258
 
# File 'lib/bunny_mock/channel.rb', line 256

def prefetch(*)
  # noop
end

#queue(name = '', opts = {}) ⇒ BunnyMock::Queue

Create a new Queue instance, or find in channel cache

Parameters:

  • name (String) (defaults to: '') —

    Name of queue

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

    Queue creation options

Returns:



222
223
224
225
 
# File 'lib/bunny_mock/channel.rb', line 222

def queue(name = '', opts = {})
  queue = @connection.find_queue(name) || Queue.new(self, name, opts)
  @connection.register_queue queue
end

#reject(delivery_tag, requeue = false) ⇒ Object

Rejects a message. A rejected message can be requeued or dropped by RabbitMQ.

Parameters:

  • delivery_tag (Integer) —

    Delivery tag to reject

  • requeue (Boolean) (defaults to: false) —

    Should this message be requeued instead of dropping it?

Returns:

  • nil



323
324
325
326
327
328
329
 
# File 'lib/bunny_mock/channel.rb', line 323

def reject(delivery_tag, requeue = false)
  if @acknowledged_state[:pending].key?(delivery_tag)
    delivery, header, body = update_acknowledgement_state(delivery_tag, :rejected)
    delivery.queue.publish(body, header.to_hash) if requeue
  end
  nil
end

#temporary_queue(opts = {}) ⇒ BunnyMock::Queue

Create a new Queue instance with no name

Parameters:

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

    Queue creation options

Returns:

See Also:



236
237
238
 
# File 'lib/bunny_mock/channel.rb', line 236

def temporary_queue(opts = {})
  queue '', opts.merge(exclusive: true)
end

#to_s ⇒ String Also known as: inspect

Returns Object representation.

Returns:

  • (String) —

    Object representation



81
82
83
 
# File 'lib/bunny_mock/channel.rb', line 81

def to_s
  "#<#{self.class.name}:#{object_id} @id=#{@id} @open=#{open?}>"
end

#topic(name, opts = {}) ⇒ BunnyMock::Exchange

Mocks a topic exchange

Parameters:

  • name (String) —

    Exchange name

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

    Exchange parameters

Options Hash (opts):

  • :durable (Boolean)
  • :auto_delete (Boolean)
  • :arguments (Hash)

Returns:



161
162
163
 
# File 'lib/bunny_mock/channel.rb', line 161

def topic(name, opts = {})
  exchange name, opts.merge(type: :topic)
end

#wait_for_confirms ⇒ Object

Does not actually wait, but always return true.

Returns:

  • true



266
267
268
 
# File 'lib/bunny_mock/channel.rb', line 266

def wait_for_confirms(*)
  true
end