bunny-mock 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c50a06b6ad300048718d1da4576cf4aa26bb3f7a
-  data.tar.gz: d3a46df9f089b40a09bf763a55dec107f1adde22
+  metadata.gz: 884e4998df1d5701f0384a2cb1c009d80ed81b67
+  data.tar.gz: 198414bf1eabff599a44310c514cbfa9ce770b0d
 SHA512:
-  metadata.gz: a66ab64795f09af460aecb30c702a177caeed40f20603a2680bdccbc8c2307f6c312fb73ec1de039c4a787c21bf671569ae7ecacae9e59143e238d27b174e852
-  data.tar.gz: fa47402ad74277744d11cbf0c560476ea507379b385d0ab2453f0d5ba1589d4938777244cd9b86a7241d608f47ade3b8535f5aa200217d3e9ef513ca480a0a44
+  metadata.gz: 868c41d0849c0ea46f2049b15e6ee9122d662f4953089baefc7e35efc37114baff7ea09c6f66bb322a03252820513115526f27e40e2c71c30f312a9526c34e7a
+  data.tar.gz: ee9f02bc843c883b4df2780a3373219bf283d9780219eccea3edc6e7bcfebca177c53806f6a379dba35469c22d2dfc1dc9dec7a2d8462eb8fbad34cc99d69f26

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.0
   DisplayCopNames: true
   Include:
     - 'lib/**/*'

data/CHANGELOG.md

@@ -2,9 +2,14 @@
 
 _Add contribution here_
 
+## v1.6.0
+
+* [#27](https://github.com/arempe93/bunny-mock/pull/27): Allow `Session#create_channel` to accept additional args - [@eebs](https://github.com/eebs)
+* [#20](https://github.com/arempe93/bunny-mock/pull/30): Adds implementation of `ack` and `nack` - [@dwhenry](https://github.com/dwhenry)
+
 ## v1.5.0
 
-*[#20](https://github.com/arempe93/bunny-mock/pull/20): Adds implementation of `Queue#subscribe` - [@baelter](https://github.com/baelter)
+* [#20](https://github.com/arempe93/bunny-mock/pull/20): Adds implementation of `Queue#subscribe` - [@baelter](https://github.com/baelter)
 
 ## v1.4.0
 

data/bunny-mock.gemspec

@@ -26,9 +26,11 @@ Gem::Specification.new do |s|
   end
 
   s.add_development_dependency 'rake', '~> 10.5.0'
-  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop', '= 0.40.0'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'rspec', '~> 3.4.0'
+  s.add_development_dependency 'term-ansicolor', '~> 1.3.0'
+  s.add_development_dependency 'tins', '= 1.6.0'
   s.add_development_dependency 'coveralls'
 
   s.files         = `git ls-files`.split "\n"

data/lib/bunny-mock.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'bunny_mock/version'
 
+require 'timeout'
 require 'bunny/exceptions'
 require 'amq/protocol/client'
 

data/lib/bunny_mock/channel.rb

@@ -14,6 +14,9 @@ module BunnyMock
     # @return [Symbol] Current channel state
     attr_reader :status
 
+    # @return [Hash] with details of pending, acked and nacked messaged
+    attr_reader :acknowledged_state
+
     ##
     # Create a new {BunnyMock::Channel} instance
     #
@@ -32,6 +35,7 @@ module BunnyMock
       # initialize exchange and queue storage
       @exchanges = {}
       @queues    = {}
+      @acknowledged_state = { pending: {}, acked: {}, nacked: {} }
 
       # set status to opening
       @status = :opening
@@ -256,13 +260,46 @@ module BunnyMock
     end
 
     ##
-    # Does nothing atm.
+    # Acknowledge message.
+    #
+    # @param [Integer] delivery_tag Delivery tag to acknowledge
+    # @param [Boolean] multiple (false) Should all unacknowledged messages up to this be acknowleded as well?
     #
     # @return nil
     # @api public
     #
-    def acknowledge(*)
-      # noop
+    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
+    alias acknowledge ack
+
+    ##
+    # Unacknowledge message.
+    #
+    # @param [Integer] delivery_tag Delivery tag to acknowledge
+    # @param [Boolean] multiple (false) Should all unacknowledged messages up to this be rejected as well?
+    # @param [Boolean] requeue  (false) Should this message be requeued instead of dropping it?
+    #
+    # @return nil
+    # @api public
+    #
+    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
 
     ##
@@ -345,5 +382,10 @@ module BunnyMock
     def xchg_find_or_create(name, opts = {})
       @connection.find_exchange(name) || Exchange.declare(self, name, opts)
     end
+
+    # @private
+    def update_acknowledgement_state(delivery_tag, new_state)
+      @acknowledged_state[new_state][delivery_tag] = @acknowledged_state[:pending].delete(delivery_tag)
+    end
   end
 end

data/lib/bunny_mock/exchanges/topic.rb

@@ -4,11 +4,11 @@ module BunnyMock
     class Topic < BunnyMock::Exchange
       # @private
       # @return [String] Multiple subdomain wildcard
-      MULTI_WILDCARD = '#'
+      MULTI_WILDCARD = '#'.freeze
 
       # @private
       # @return [String] Single subdomain wildcard
-      SINGLE_WILDCARD = '*'
+      SINGLE_WILDCARD = '*'.freeze
 
       #
       # API

data/lib/bunny_mock/get_response.rb

@@ -14,11 +14,15 @@ module BunnyMock
     # @return [BunnyMock::Channel] Channel the response is from
     attr_reader :channel
 
+    # @return [BunnyMock::Queue] Queue the response is from
+    attr_reader :queue
+
     # @private
     def initialize(channel, queue, opts = {})
       @channel = channel
+      @queue = queue
       @hash = {
-        delivery_tag: '',
+        delivery_tag: self.class.next_delivery_tag,
         redelivered:  false,
         exchange:     opts.fetch(:exchange, ''),
         routing_key:  opts.fetch(:routing_key, queue.name)
@@ -72,5 +76,11 @@ module BunnyMock
     def routing_key
       @hash[:routing_key]
     end
+
+    # @return [Integer] incrementing numerically value to support `#ack` with multiple=true
+    def self.next_delivery_tag
+      @delivery_tag ||= 0
+      @delivery_tag += 1
+    end
   end
 end

data/lib/bunny_mock/queue.rb

@@ -72,14 +72,30 @@ module BunnyMock
     ##
     # Adds a consumer to the queue (subscribes for message deliveries).
     #
-    # All params are ignored atm. Takes a block which is called when a message is delivered
-    # to the queue
+    # Params are so they can be used when the message is processed. Takes a block which is called when a message
+    # is delivered to the queue
     #
     # @api public
     #
-    def subscribe(*_args, &block)
+    def subscribe(*args, &block)
       @consumers ||= []
-      @consumers << block
+      @consumers << [block, args]
+      yield_consumers
+
+      self
+    end
+
+    ##
+    # Adds a specific consumer object to the queue (subscribes for message deliveries).
+    #
+    # @param [#call] consumer A subclass of Bunny::Consumer or any callable object
+    # Secondary params are so they can be used when the message is processed.
+    #
+    # @api public
+    #
+    def subscribe_with(consumer, *args)
+      @consumers ||= []
+      @consumers << [consumer, args]
       yield_consumers
 
       self
@@ -241,13 +257,21 @@ module BunnyMock
     # @private
     def yield_consumers
       return if @consumers.nil?
-      @consumers.each do |c|
+      @consumers.each do |c, args|
         # rubocop:disable AssignmentInCondition
         while message = all.pop
           response = pop_response(message)
+          store_acknowledgement(response, args)
           c.call(response)
         end
       end
     end
+
+    def store_acknowledgement(response, args)
+      if args[0].is_a?(Hash) && args[0][:manual_ack]
+        delivery_tag = response[0][:delivery_tag]
+        @channel.acknowledged_state[:pending][delivery_tag] = response
+      end
+    end
   end
 end

data/lib/bunny_mock/session.rb

@@ -88,9 +88,9 @@ module BunnyMock
     #
     # @return [BunnyMock::Channel] Channel instance
     # @api public
-    def create_channel(n = nil, _pool_size = 1)
+    def create_channel(n = nil, _pool_size = 1, *_args)
       # raise same error as {Bunny::Session#create_channel}
-      raise ArgumentError, 'channel number 0 is reserved in the protocol and cannot be used' if n == 0
+      raise ArgumentError, 'channel number 0 is reserved in the protocol and cannot be used' if n && n.zero?
 
       # return cached channel if exists
       return @channels[n] if n && @channels.key?(n)

data/lib/bunny_mock/version.rb

@@ -3,5 +3,5 @@
 
 module BunnyMock
   # @return [String] Version of the library
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'.freeze
 end

data/spec/integration/message_acknowledgement_spec.rb

@@ -0,0 +1,87 @@
+describe BunnyMock::Channel, 'acknowledgement' do
+  let(:queue) { @channel.queue('test.q') }
+  let(:delivery_tags) { {} }
+
+  context 'when `manual_ack` = true' do
+    before do
+      queue.subscribe(manual_ack: true) do |delivery, _headers, body|
+        delivery_tags[body] = delivery[:delivery_tag]
+      end
+      queue.publish 'Another message on the queue'
+    end
+
+    it 'should allow messages which have been acked to be identified' do
+      queue.publish 'Message to acknowledge'
+      delivery_tag = delivery_tags['Message to acknowledge']
+      @channel.ack delivery_tag
+
+      expect(@channel.acknowledged_state[:pending]).not_to include(delivery_tag)
+      expect(@channel.acknowledged_state[:acked]).to include(delivery_tag)
+    end
+
+    it 'should allow messages which have not been acked to be identified' do
+      queue.publish 'Message without acknowledgement'
+      delivery_tag = delivery_tags['Message without acknowledgement']
+
+      expect(@channel.acknowledged_state[:pending]).to include(delivery_tag)
+      expect(@channel.acknowledged_state[:acked]).not_to include(delivery_tag)
+    end
+
+    it 'should allow messages which have been nacked to be identified' do
+      queue.publish 'Message to nack'
+      delivery_tag = delivery_tags['Message to nack']
+      @channel.nack delivery_tag
+
+      expect(@channel.acknowledged_state[:pending]).not_to include(delivery_tag)
+      expect(@channel.acknowledged_state[:acked]).not_to include(delivery_tag)
+      expect(@channel.acknowledged_state[:nacked]).to include(delivery_tag)
+    end
+
+    it 'should requeue messages with have been nacked with `requeue` = true' do
+      queue.publish 'Message to nack'
+      delivery_tag = delivery_tags['Message to nack']
+      @channel.nack delivery_tag, false, true
+      new_delivery_tag = delivery_tags['Message to nack']
+
+      expect(@channel.acknowledged_state[:pending]).not_to include(delivery_tag)
+      expect(@channel.acknowledged_state[:acked]).not_to include(delivery_tag)
+      expect(@channel.acknowledged_state[:nacked]).to include(delivery_tag)
+
+      expect(@channel.acknowledged_state[:pending]).to include(new_delivery_tag)
+    end
+
+    it 'should allow multiple messages to be acked when `multiple` = true' do
+      queue.publish 'Message to be automatically acked'
+      delivery_tag_1 = delivery_tags['Message to be automatically acked']
+      queue.publish 'Message to acked'
+      delivery_tag_2 = delivery_tags['Message to acked']
+      queue.publish 'Message to be left as pending'
+      delivery_tag_3 = delivery_tags['Message to be left as pending']
+
+      @channel.ack delivery_tag_2, true
+
+      expect(@channel.acknowledged_state[:pending]).not_to include(delivery_tag_1)
+      expect(@channel.acknowledged_state[:pending]).not_to include(delivery_tag_2)
+      expect(@channel.acknowledged_state[:pending]).to include(delivery_tag_3)
+      expect(@channel.acknowledged_state[:acked]).to include(delivery_tag_1)
+      expect(@channel.acknowledged_state[:acked]).to include(delivery_tag_2)
+    end
+
+    it 'should allow multiple messages to be nacked when `multiple` = true' do
+      queue.publish 'Message to be automatically nacked'
+      delivery_tag_1 = delivery_tags['Message to be automatically nacked']
+      queue.publish 'Message to nacked'
+      delivery_tag_2 = delivery_tags['Message to nacked']
+      queue.publish 'Message to be left as pending'
+      delivery_tag_3 = delivery_tags['Message to be left as pending']
+
+      @channel.nack delivery_tag_2, true
+
+      expect(@channel.acknowledged_state[:pending]).not_to include(delivery_tag_1)
+      expect(@channel.acknowledged_state[:pending]).not_to include(delivery_tag_2)
+      expect(@channel.acknowledged_state[:pending]).to include(delivery_tag_3)
+      expect(@channel.acknowledged_state[:nacked]).to include(delivery_tag_1)
+      expect(@channel.acknowledged_state[:nacked]).to include(delivery_tag_2)
+    end
+  end
+end

data/spec/unit/bunny_mock/queue_spec.rb

@@ -172,6 +172,39 @@ describe BunnyMock::Queue do
       end
       @queue.publish 'test'
     end
+
+    it 'should create responses with uniq delivery_tags' do
+      delivery_tags = []
+      @queue.subscribe do |delivery, _headers, _body|
+        delivery_tags << delivery[:delivery_tag]
+      end
+      @queue.publish 'test one'
+      @queue.publish 'test two'
+
+      expect(delivery_tags.uniq.count).to eq(2)
+    end
+
+    context 'when `manual_ack` is set to true' do
+
+      it 'should mark the message as unacknowledged on the channel before processing' do
+        @queue.subscribe(manual_ack: true) do |delivery, _headers, _body|
+          expect(@channel.acknowledged_state[:pending]).to include(delivery[:delivery_tag])
+        end
+        @queue.publish 'test'
+      end
+    end
+  end
+
+  context '#subscribe_with' do
+
+    it 'should consume messages delivered' do
+      consumer = proc do |_delivery, _headers, body|
+        expect(body).to eq('test')
+      end
+    
+      @queue.subscribe_with consumer
+      @queue.publish 'test'
+    end
   end
 
   context '#purge' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bunny-mock
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Andrew Rempe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-17 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -42,16 +42,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.40.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.40.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: tins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +156,7 @@ files:
 - lib/bunny_mock/queue.rb
 - lib/bunny_mock/session.rb
 - lib/bunny_mock/version.rb
+- spec/integration/message_acknowledgement_spec.rb
 - spec/integration/queue_pop_spec.rb
 - spec/integration/queue_subscribe_spec.rb
 - spec/spec_helper.rb
@@ -159,11 +188,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Mocking for the popular Bunny client for RabbitMQ
 test_files:
+- spec/integration/message_acknowledgement_spec.rb
 - spec/integration/queue_pop_spec.rb
 - spec/integration/queue_subscribe_spec.rb
 - spec/spec_helper.rb